REST API Reference for Pricing Design Center

Get Changeset Status by ID

get

/pdc/changeset/status/by-ids

Returns the status of a changeset by its ID.

Request

Query Parameters

ids(required): array[string]
Specifies one or more changeset IDs for which to retrieve status.
Example:
```
3810,38810,38910,27973,36150,36800,38964,39158
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The request was processed successfully.

Root Schema : ChangeSetStatusEnvelope

Type: object

Container for a changeset status report.

Show Source

changeSetStatusReport: object ChangeSetStatusReport

Report containing changeset status details and warnings.

{
    "type":"object",
    "description":"Container for a changeset status report.",
    "properties":{
        "changeSetStatusReport":{
            "$ref":"#/components/schemas/ChangeSetStatusReport",
            "description":"Provides the changeset status results and any warning message."
        }
    }
}

Nested Schema : ChangeSetStatusReport

Type: object

Report containing changeset status details and warnings.

Show Source

changeSets: array changeSets

Lists the changesets that PDC found and processed.
warning: string

Describes requested changesets that were invalid or not found.

{
    "type":"object",
    "description":"Report containing changeset status details and warnings.",
    "properties":{
        "warning":{
            "type":"string",
            "description":"Describes requested changesets that were invalid or not found."
        },
        "changeSets":{
            "type":"array",
            "description":"Lists the changesets that PDC found and processed.",
            "items":{
                "$ref":"#/components/schemas/ChangeSet"
            }
        }
    }
}

Nested Schema : changeSets

Type: array

Lists the changesets that PDC found and processed.

Show Source

Array of: object ChangeSet

Status information for a single changeset.

{
    "type":"array",
    "description":"Lists the changesets that PDC found and processed.",
    "items":{
        "$ref":"#/components/schemas/ChangeSet"
    }
}

Nested Schema : ChangeSet

Type: object

Status information for a single changeset.

Show Source

changeSetId: string

Identifies the changeset uniquely.

Example: 3810
changeSetName: string

Specifies the changeset name.

Example: MIGRATION_CHANGESET_SYNC_EVENT
changeSetStatus: string

Reports the changeset’s overall processing status.

Example: PENDING
transformations: array transformations

Provides status details for each transformation that PDC performed for the changeset.

{
    "type":"object",
    "description":"Status information for a single changeset.",
    "properties":{
        "changeSetId":{
            "type":"string",
            "description":"Identifies the changeset uniquely.",
            "example":"3810"
        },
        "changeSetName":{
            "type":"string",
            "description":"Specifies the changeset name.",
            "example":"MIGRATION_CHANGESET_SYNC_EVENT"
        },
        "changeSetStatus":{
            "type":"string",
            "description":"Reports the changeset’s overall processing status.",
            "example":"PENDING"
        },
        "transformations":{
            "type":"array",
            "description":"Provides status details for each transformation that PDC performed for the changeset.",
            "items":{
                "$ref":"#/components/schemas/Transformation"
            }
        }
    }
}

Nested Schema : transformations

Type: array

Provides status details for each transformation that PDC performed for the changeset.

Show Source

Array of: object Transformation

Status information for a changeset transformation job.

{
    "type":"array",
    "description":"Provides status details for each transformation that PDC performed for the changeset.",
    "items":{
        "$ref":"#/components/schemas/Transformation"
    }
}

Nested Schema : Transformation

Type: object

Status information for a changeset transformation job.

Show Source

jobId: integer

Identifies the transformation job.

Example: 14233
jobStatus: string

Reports the transformation job’s current status.

Example: DISPATCHED
type: string

Specifies the target system or transformation type, such as ECE, BRE, or RRE.

Example: ECE

{
    "type":"object",
    "description":"Status information for a changeset transformation job.",
    "properties":{
        "jobId":{
            "type":"integer",
            "description":"Identifies the transformation job.",
            "example":14233
        },
        "jobStatus":{
            "type":"string",
            "description":"Reports the transformation job’s current status.",
            "example":"DISPATCHED"
        },
        "type":{
            "type":"string",
            "description":"Specifies the target system or transformation type, such as ECE, BRE, or RRE.",
            "example":"ECE"
        }
    }
}

Examples

The following example shows how to get the status of changesets by ID by submitting a GET request on the REST resource using cURL. For more information, see Use cURL.

curl -X GET 'http://hostname:port/pdc/changeset/status/by-ids?ids=3810,38810,38910,27973'

Example of Response Body

If successful, the response code 200 is returned along with a changeSetStatusReport in JSON format containing changeset IDs, names, statuses, transformation details, and any warnings:

{
  "changeSetStatusReport": {
    "changeSets": [
      {
        "changeSetId": "3810",
        "changeSetName": "MIGRATION_CHANGESET_SYNC_EVENT",
        "changeSetStatus": "PENDING",
        "transformations": [
          {
            "jobId": 14233,
            "jobStatus": "DISPATCHED",
            "type": "ECE"
          }
        ]
      },
      {
        "changeSetId": "27973",
        "changeSetName": "MIGRATION_CHANGESET_SYNC_SERVICE",
        "changeSetStatus": "PENDING",
        "transformations": [
          {
            "jobId": 32015,
            "jobStatus": "DISPATCHED",
            "type": "ECE"
          }
        ]
      }
    ],
    "warning": "Warning: The following ChangeSet ID(s) were invalid or not found: 38810, 38910"
  }
}