# Operative Process (Operations)

Get operative processes.

## List operative processes

> This part of the API is in Alpha status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Get all operative processes

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Get operative processes.","name":"Operative Process (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OperativeProcessPaginatedResult":{"properties":{"operativeProcesses":{"items":{"$ref":"#/components/schemas/OperativeProcess"},"type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","operativeProcesses"],"title":"OperativeProcessPaginatedResult","type":"object","description":"OperativeProcessPaginatedResult"},"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","PARCEL","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/operativeprocesses":{"get":{"deprecated":false,"description":"This part of the API is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Get all operative processes","operationId":"getOperativeProcesses","parameters":[{"description":"facility to filter the results","in":"query","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperativeProcessPaginatedResult"}}},"description":"All operative processes matching the given parameters"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"List operative processes","tags":["Operative Process (Operations)"]}}}}
```

## Get operative process

> This part of the API is in Alpha status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Get the operative processes for a specific id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Get operative processes.","name":"Operative Process (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","PARCEL","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/operativeprocesses/{operativeProcessId}":{"get":{"deprecated":false,"description":"This part of the API is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Get the operative processes for a specific id","operationId":"getOperativeProcessById","parameters":[{"in":"path","name":"operativeProcessId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperativeProcess"}}},"description":"Found operativeProcess by given ID"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get operative process","tags":["Operative Process (Operations)"]}}}}
```
