lifecycle

Retrieve, modify, or delete object type workflows. 

 GET  /object/objectType/{objectTypeId}/objectLifeCycle

Retrieve all workflows and workflow states for an object type.

Curl Request
curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer YOUR_API_KEY' 'https://YOUR_ENVIRONMENT.resolver.com/object/objectType/6020/objectLifeCycle?includeStates=true'
Parameters
NameParameter TypeData TypeDescriptionRequired
objectTypeIdpathdoubleThe object type you want to retrieve the workflows for.Yes
includeStatesquerybooleanIf true, the response will include workflow states.No
Success Response

200 OK

Example Response Body
{
  "data": [
    {
      "id": 7421,
      "name": "GS Injury",
      "type": 1,
      "nameKey": "app:objectLifeCycle:name:c25dbe52-f46e-4d2c-b620-7ddc99df0855",
      "description": null,
      "descriptionKey": "app:objectLifeCycle:description:2a1d0022-a65f-4421-b526-035dbb4bed6e",
      "created": "2019-04-24T15:36:06.804Z",
      "modified": "2019-04-24T15:36:06.804Z",
      "org": 46,
      "nextStateOrdinal": 1,
      "externalRefId": "2cce6a45-5392-4916-8254-14dea960749e",
      "objectTypeId": 6020,
      "states": [
        {
          "id": 29660,
          "objectLifeCycleId": 7421,
          "name": "Creation",
          "stateCategoryId": null,
          "nameKey": "app:objectLifeCycleState:name:b7de667d-d379-4c92-81cb-f537024277be",
          "color": "#0fc0fc",
          "ordinal": -1,
          "created": "2019-04-24T15:36:06.804Z",
          "modified": null,
          "org": 46,
          "creation": true,
          "externalRefId": "0f7bd9e8-106f-4e3b-8cbb-ea66d31165ee"
        },
        {
          "id": 29661,
          "objectLifeCycleId": 7421,
          "name": "Draft",
          "stateCategoryId": 1,
          "nameKey": "app:objectLifeCycleState:name:9c839e30-e2df-4a7d-bfc4-cad50dc560a9",
          "color": "#0fc0fc",
          "ordinal": 0,
          "created": "2019-04-24T15:36:06.804Z",
          "modified": null,
          "org": 46,
          "creation": false,
          "externalRefId": "6867d477-9b7b-42bb-a223-157e604c5bfc"
        },
        {
          "id": 29662,
          "objectLifeCycleId": 7421,
          "name": "Active",
          "stateCategoryId": 2,
          "nameKey": "app:objectLifeCycleState:name:47a6cc00-bbc0-47c7-97dc-058e42a066fe",
          "color": "#0fc0fc",
          "ordinal": 1,
          "created": "2019-04-24T15:36:06.804Z",
          "modified": null,
          "org": 46,
          "creation": false,
          "externalRefId": "78e2b3af-bc6c-4ba1-b0fa-a85b8e752c53"
        },
        {
          "id": 29663,
          "objectLifeCycleId": 7421,
          "name": "Archived",
          "stateCategoryId": 3,
          "nameKey": "app:objectLifeCycleState:name:1bf39775-6d9a-4d32-aff9-4a77313b52f0",
          "color": "#0fc0fc",
          "ordinal": 2,
          "created": "2019-04-24T15:36:06.804Z",
          "modified": null,
          "org": 46,
          "creation": false,
          "externalRefId": "d04afd5e-ab5b-4d23-8022-509f909f8b0b"
        }
      ]
    }
  ]
}