Operation Get Plans By Criteria

Method: HTTP POST method

Endpoint:http://<host_address>:<port_address>/v1/plansByCriteria

Parameter content type: application/json

The plan search criteria is as follows:

  • planId
  • orderId
  • orderRef
  • dateRange
  • planStatusList
  • planItemStatusList
  • processComponentIdList
  • processComponentNameList
Note:

Only the following combinations are allowed and no other combinations of search criteria are allowed:

  • dateRange and planStatusList
  • dateRange and planItemStatusList
  • dateRange and processComponentIdList
  • dateRange and processComponentNameList

Example of plansByCriteria:

{
  "sortCriteria": {
    "sortFields": [
      {
        "field": "ORDER_ID",
        "sortBy": "ASC",
        "sortSequence": 0
      }
    ]
  },
  "planId": "string",
  "orderId": "string",
  "orderRef": "string",
  "dateRange": {
    "startDate": "2022-09-13T09:52:27.243Z",
    "endDate": "2022-09-13T09:52:27.243Z"
  },
  "planStatusList": [
    "string"
  ],
  "planItemStatusList": [
    "string"
  ],
  "processComponentIdList": [
    "string"
  ],
  "processComponentNameList": [
    "string"
  ],
  "pagination": {
    "startRecord": 0,
    "endRecord": 0,
    "totalRecords": 0
  },
  "count": 0
}