Operation Get Plans By Criteria
Method: HTTP POST method
Endpoint: http://<host_address>:<port_address>/v2/plans/criteria
Parameter content type: application/json
The plan search criteria are 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
andplanStatusList
dateRange
andplanItemStatusList
dateRange
andprocessComponentIdList
dateRange
andprocessComponentNameList
Example of
plansByCriteria
:
{ "planId": [ "string" ], "orderId": [ "string" ], "orderRef": [ "string" ], "dateRange": { "startDate": "2023-10-09T19:43:19.763Z", "endDate": "2023-10-09T19:43:19.763Z" }, "planStatusList": [ "START, PENDING, EXECUTION, COMPLETE, CANCELLED, SUSPENDING, SUSPENDED" ], "planItemStatusList": [ "string" ], "processComponentIdList": [ "string" ], "processComponentNameList": [ "string" ], "currentPage": 0, "recordsPerPage": 0, "filterOperator": "IN" }