Get Plan Items Response
The response message contains the following header properties:
Element |
Type |
Cardinality |
Description |
Success |
Boolean |
Required |
Flag indicating if the call was successful. |
messageCode |
String |
Required |
Result message code. |
Message |
String |
Required |
Result message. |
planID |
String |
Required |
Internal unique identifier for the plan specified in the request. |
Found |
Boolean |
Required |
Flag indicating if the plan was found. |
The following table lists the details of the response elements.
Element | Type | Cardinality | Description |
resultStatus | Type | See Image | Result status type. See Appendix A for the specification of this type. |
planItem | Type | 0-M | Plan item type. |
planItem/planItemID | String | Required | Internal unique identifier for the plan item. |
planItem/planItemName | String | Optional | Name of the process component. |
planItem/udf | Type | 0-M | user-defined field type. |
planItem/udf/type | String | Optional | Type of the user defined field. |
planItem/udf/flavour | String | Optional | Flavor of the user-defined field. The valid values are one of the following three: |
planItem/udf/name | String | Required | Field name. |
planItem/udf/value | String | Optional | Field value. |
planItem/udf/originalValue | String | Optional | Original field value at the time of plan creation. |
planItem/udf/lastModified | DateTime | Optional | Timestamp when the user-defined field was last modified. |
planItem/parentID | String | 0-M | IDs of the plan items, which depends on the current plan item. |
planItem/childID | String | 0-M | IDs of the plan items on which the current plan item depends. |
planItem/siblingID | String | 0-M | IDs of the plan items corresponding to SIBLING_PRODUCT_* of the product fulfilled by current plan item. |
planItem/dependentID | String | 0-M | IDs of the plan items corresponding to DEPENDENT_PRODUCT_* of the product fulfilled by current plan item. |