Resource that manages changes.
JSON request templates
Some commands in this resource generate JSON output in multiple formats, as specified by the
format parameter.
These output formats include different subsets of properties for the requested elements, as appropriate for different use cases.
The included properties for each format are described in the JSON templates below.
- TEMPLATE_ROOT
{
"dateCreated": "Timestamp that represents the date when
the change was created.",
"id": "Change ID",
"severity": "Change severity (S1, S2, OTHER)",
"status": "Change status (New, In Progress, Completed,
Accepted)",
"version": "Version number"
}
- list, detail
{
"application": "(See: application TEMPLATE_LIST)",
"dateCreated": "Timestamp that represents the date when
the change was created.",
"id": "Change ID",
"initiative": "(See: initiative TEMPLATE_LIST)",
"integrationProvider": {
"currentState": "If the Integration is running or not.
(Running or Finished)",
"dateCreated": "Timestamp that represents the date
when the Integration Provider has been created.",
"executionReport": "[JsonArray of logs that represents
the last execution report]",
"frequency": "Frequency in minutes that the
Integration Provider will be run at, 0 means the
Integration Provider will be run manually only.",
"ghostedDate": "Timestamp that represents the date
when the Integration Provider has been deleted. If greater
than 0 the Integration Provider has been removed.",
"id": "Integration Provider ID",
"lastExecutionStatus": "Status of the last execution
of the Integration. (Failed or Success)",
"name": "Integration Provider Name",
"version": "Version number"
},
"release": "(See: release TEMPLATE_LIST)",
"severity": "Change severity (S1, S2, OTHER)",
"status": "Change status (New, In Progress, Completed,
Accepted)",
"type": "(See: changeType NAME_ID_TEMPLATE)",
"version": "Version number"
}
- externalIntegrationDetails
{
"application": "(See: application TEMPLATE_LIST)",
"dateCreated": "Timestamp that represents the date when
the change was created.",
"id": "Change ID",
"initiative": "(See: initiative TEMPLATE_LIST)",
"integrationPropSheet": "Properties that are related to
the integration",
"integrationProvider": {
"currentState": "If the Integration is running or not.
(Running or Finished)",
"dateCreated": "Timestamp that represents the date
when the Integration Provider has been created.",
"executionReport": "[JsonArray of logs that represents
the last execution report]",
"frequency": "Frequency in minutes that the
Integration Provider will be run at, 0 means the
Integration Provider will be run manually only.",
"ghostedDate": "Timestamp that represents the date
when the Integration Provider has been deleted. If greater
than 0 the Integration Provider has been removed.",
"id": "Integration Provider ID",
"lastExecutionStatus": "Status of the last execution
of the Integration. (Failed or Success)",
"name": "Integration Provider Name",
"version": "Version number"
},
"release": "(See: release TEMPLATE_LIST)",
"severity": "Change severity (S1, S2, OTHER)",
"status": "Change status (New, In Progress, Completed,
Accepted)",
"type": "(See: changeType NAME_ID_TEMPLATE)",
"version": "Version number"
}