Workflows - Requests API

List all requests of a workflow

List all requests of a workflow with a specific ID.

GET /workflows/:id/requests

Response

status: 200 OK
[
  {
    "service_instance": {
      "name": "Windows for Sales Tracking Production",
      "id": 126
    },
    "completed_at": null,
    "created_at": "2016-03-14T02:56:11-06:00",
    "category": "rfc",
    "sourceID": null,
    "updated_at": "2016-03-14T03:14:11-06:00",
    "grouped_into": null,
    "member": {
      "name": "Barney Turban",
      "id": 58
    },
    "subject": "Add memory to Sales Tracking production server cluster",
    "id": 70470,
    "impact": null,
    "team": {
      "name": "Windows Servers",
      "id": 14
    },
    "status": "assigned",
    "next_target_at": "best_effort"
  },
  "..."
]

The response contains these fields by default.

The collection holds the requests of the account in the X-Xurrent-Account header, as described under Multiple Accounts, with the status, team and member of that account. Filtering, sorting and pagination work as for the Requests API. By default the collection is sorted ascending by status, then by id.

In a directory account, the collection holds the requests of the account of the record, or of an account through which the API user has access to the record.

Predefined Filters

The following predefined filters are available:

Add a request to a workflow

Add a link between a workflow with a specific ID and a request with a specific ID.

POST /workflows/:id/requests/:request_id

Response

status: 200 OK
{}

Remove a request from a workflow

Remove the link between a workflow with a specific ID and a request with a specific ID.

DELETE /workflows/:id/requests/:request_id

Response

status: 204 No Content

Remove all requests from a workflow

Remove all links between a workflow with a specific ID and its requests.

DELETE /workflows/:id/requests

Response

status: 204 No Content