Get Plan Response
The response message contains the following header properties:
Element |
Type |
Cardinality |
Description |
success |
Boolean |
Required |
The flag indicating if the call was successful. |
messageCode |
String |
Required |
The result message code. |
message |
String |
Required |
The result message. |
planID |
String |
Required |
The internal unique identifier for the plan specified in the request. |
found |
Boolean |
Required |
The flag indicating if the plan was found. |
The following table lists the details of the response elements.
Element | Type | Cardinality | Description |
resultStatus | Type | Required | The result status type. See Appendix A for the specification of this type. |
plan | Type | Optional | The plan type. If the plan is not found, this is omitted. |
plan/planID | String | Required | The internal unique identifier for the plan. |
plan/orderID | String | Required | The internal unique identifier for the order for the plan. |
plan/orderRef | String | Required | External unique identifier for the order for the plan. |
plan/udf | Type | 0-M | user-defined field type. |
plan/udf/type | String | Optional | Type of the user defined field. |
plan/udf/flavour | String | Optional | Flavor of the user-defined field. The valid values are one of the following three: |
plan/udf/name | String | Required | Field name. |
plan/udf/value | String | Optional | Field value. |
plan/udf/originalValue | String | Optional | Original field value at the time of plan creation. |
plan/udf/lastModified | DateTime | Optional | Timestamp when the user-defined field was last modified. |
plan/planItem | Type | 0-M | Plan item type. |
plan/planItem/planItemID | String | Required | Internal unique identifier for the plan item. |
plan/planItem/planItemName | String | Optional | Name of the process component. |
plan/planItem/udf | Type | 0-M | user-defined field type. |
plan/planItem/udf/type | String | Optional | Type of the user defined field. |
plan/planItem/udf/flavour | String | Optional | Flavor of the user-defined field. The valid values are one of the following three: |
plan/planItem/udf/name | String | Required | Field name. |
plan/planItem/udf/value | String | Optional | Field value. |
plan/planItem/udf/originalValue | String | Optional | Original field value at the time of plan creation. |
plan/planItem/udf/lastModified | DateTime | Optional | Timestamp when the user-defined field was last modified. |
plan/planItem/parentID | String | 0-M |
IDs of the plan items, which depend on the current plan item. |
plan/planItem/childID | String | 0-M | IDs of the plan items on, which the current plan item depends. |
plan/planItem/siblingID | String | 0-M | IDs of the plan items corresponding to SIBLING_PRODUCT_* of the product fulfilled by current plan item. |
plan/planItem/dependentID | String | 0-M | IDs of the plan items corresponding to DEPENDENT_PRODUCT_* of the product fulfilled by current plan item. |
plan/status | String | Required | Status of the plan from a data perspective: active or complete. |
plan/planDescription | String | Optional | Plan description. |