v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Requisition API:Requisitions

Get a requisition

get/requisitions/{requisitionId}

Path parameters

requisitionIdinteger required

Requisition Id

Query parameters

Embedstring[]

Embed related resources.<br /> Resources available to embed are: notes

Response

Requested requisition details

requisitionIdinteger required
status'Draft' | 'Submitted' | 'Rejected' | 'Approved' | 'Closed' string
workflowStageIndexinteger nullable
jobTitlestring required
jobOrderIdinteger nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
jobDescriptionstring nullable
numberOfJobsinteger
sourcestring nullable

Source of the requisition, or reason the requisition is being raised.

formIDinteger nullable

Example response

{
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}