Change Request JSON Reference

JSON Syntax for /ChangeRequest endpoints.

ChangeRequest

Use Change Requests to request changes on governed objects.

You can request creation, update or removal of objects and invocation of extension actions.

{
  // Change Request operation
  "operation": #ChangeRequest.operation,

  // Target Object configuration
  "configuration": #ChangeRequest.configuration,

  // Object Property Values
  "data": #ChangeRequest.data,

  // Execution time (optional).
  // If you don't specifiy a execution time, the request will be scheduled in the next scheduling cycle.
  "executionPlannedOn": "2023-12-01T09:36:11.570Z"
}

ChangeRequest.operation

The operation for a change request is defined by the target object and the action to perform.

{
  "operation": {
    // You must provide either 'alias' or 'id' plus 'action'.
    // For action="Create" you don't need "id", but you can assign an "alias".

    // Alias of Target Object
    "alias": "string",
    // ID of Target Object
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    // Requested action: Create | Update | Delete | Remove | CustomAction
    "action": "string",
    // If request action is "Custom", this field will be the action name
    "customActionName": "string"
  }
}

ChangeRequest.configuration

The configuration for the target object is needed when you perform a "Create" or "Update" action. It consists of target object schema and profiles.

The Schema is only required for "Create" action. Profiles can be edited with "Create" and "Update" actions.

{
  "configuration": {
    // Schema ID (for Create action only)
    "schema": "string",
    // Set of profiles to apply to the object. These profiles will replace all existing profiles.
    "setProfiles": [ #Profile.id, ... ],
    // Append a list of profiles to the object. These profiles will be added at the end of the existing profiles.
    "appendProfiles": [ #Profile.id, ... ],
    // Remove a list of profiles from the object. These profiles will be removed from the existing profiles.
    "removeProfiles": [ #Profile.id, ...]
  }
}

ChangeRequest.data

In ChangeRequest.data you put the desired master values for the target object. This works on "Create" and "Update" actions.

{
// Object Property Values
  "data": {
    // "<Property>": <MasterValue>, ...
    "<ConfigurationType>.<Property>": string | number | boolean | ...,
    ...
  }
}