This table aggregates membership for all versions of the Change object.

Versioned schema members

Any object member specific to a range of versions is indicated in its description, at what version the member was either introduced or removed. Any listed data member with no version number is common to all versions of the object.

MemberTypeDescription
Change: Any change that you want to make to the network deployment of an enrollment.
allowed‚ÄčInputChange.‚Äčallowed‚ÄčInput[]required: The resource locations (path) of data inputs allowed by this change. These could be required or optional for this change to proceed.
status‚ÄčInfoChange.‚Äčstatus‚ÄčInforequired: The status for this Change at this time.
Change.allowed‚ÄčInput[]: The resource locations (path) of data inputs allowed by this change. These could be required or optional for this change to proceed.
infoStringrequired: The resource location for the description of the allowed input.
required‚ÄčTo‚ÄčProceedBooleanrequired: If true, this input is required for the Change to proceed.
typeStringrequired: The type input. For more information see the [Overview.
updateStringrequired: The resource location that you can use to make a call for this input.
Change.status‚ÄčInfo: The status for this Change at this time.
deployment‚ÄčScheduleChange.‚Äčstatus‚ÄčInfo.‚Äčdeployment‚ÄčSchedulerequired: The schedule for when you want this change deploy.
descriptionStringrequired: A description of the current status of the change.
errorChange.‚Äčstatus‚ÄčInfo.‚Äčerror, NullError information for this change.
stateStringrequired: The current sub-state of the change. It represents detailed information regarding to the status of the change, such is if the change is in progress, in error state, awaiting user input, and so on.
statusStringrequired: The general status of the change. This is a high level of description of the status for the change.
Change.status‚ÄčInfo.deployment‚ÄčSchedule: The schedule for when you want this change deploy.
not‚ÄčAfterString, NullDo not deploy the certificate after this date.
not‚ÄčBeforeString, NullDo not deploy the certifiacte before this date.
Change.status‚ÄčInfo.error: Error information for this change.
codeStringrequired: The unique identifier code for this error.
descriptionStringrequired: The detailed description for this error.
timestampStringrequired: The timestamp of the occurrence for this error.

Sample v1 object

TBD

{
    "allowedInput": [
        {
            "info": "/cps/v2/enrollments/10002/changes/10002/input/info/third-party-csr",
            "requiredToProceed": true,
            "type": "third-party-certificate",
            "update": "/cps/v2/enrollments/10002/changes/10002/input/update/third-party-cert-and-trust-chain"
        }
    ],
    "statusInfo": {
        "deploymentSchedule": {
            "notAfter": null,
            "notBefore": null
        },
        "description": "Waiting for you to upload and submit your third party certificate and trust chain.",
        "error": null,
        "state": "awaiting-input",
        "status": "wait-upload-third-party"
    }
}