Get Actions

HTTP request

Replace the URL prefix for Action Tracker depending on environment following the guideline.

HTTP

GET http://localhost:7071/api/actions
Content-Type: application/json
Authorization: Bearer {{TOKEN}}

Request headers

Header	Value
Authorization	Bearer `{token}`. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an actions object and total count in the response body.

HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 26 Jun 2024 07:04:07 GMT
Server: Kestrel
Transfer-Encoding: chunked

Example

Reqeust

Here is an example of the request.

HTTP

GET http://localhost:7071/api/actions
Content-Type: application/json
Authorization: Bearer {{TOKEN}}

URI Parameters

The following additional parameters may be specified on the request URI for filtering:

Parameter	Description
`title`	Optional. Filters the list based on the action's `title` field. Case-insensitive. The value must be a string.
`status`	Optional. Filters the list based on the action's `status` field. The value must be an integer.
`priority`	Optional. Filters the list based on the action's `priority` field. The value must be an integer.
`dueAt`	Optional. Filters the list based on the action's `dueAt` field. The value must be a date string.
`assignee`	Optional. Filters the list based on the action's `assignee` field. The value must be a string.
`owner`	Optional. Filters the list based on the action's `owner` field. The value must be a string.
`actionProducer.name`	Optional. Filters the list based on the action producer's `name` field. The value must be a string.
`actionProducer.reference`	Optional. Filters the list based on the action producer's `reference` field. The value must be a string.
`location.*`	Optional. Filters the list based on fields within the `location` object. Replace `*` with the name of the field within `location`.
`createdAt`	Optional. Filters the list based on the action's `createdAt` field. The value must be a date string.
`updatedAt`	Optional. Filters the list based on the action's `updatedAt` field. The value must be a date string.
`skip`	Optional. Defaults to `0`. Number of records to skip for pagination. The value must be an integer.
`limit`	Optional. Defaults to `10`. Maximum number of records to return. The value must be an integer.
`sort`	Optional. Specifies the field to sort by and the direction (e.g., `title` for ascending and `-title` for descending). The value must be a string.

Granular filtering is possible through these operators:

Operator	Description
`=`	Equal to
`!`	Not equal to
`*`	Like (for partial matches)
`<`	Smaller than
`>`	Greater than
`~`	In (for specifying a list of values, comma-separated)

To use these operators, append them to the parameter in the query string. For example, to filter actions with a priority greater than 0, you would specify priority=>0 in the query string.

Response

Here is an example of the response.

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

JSON

{
  "actions": [
    {
      "id": "66711abf83dd422a270e911b",
      "title": "Anonymous Sprint review Machine spindle is broken again",
      "description": "The machine spindle is broken and needs to be replaced.",
      "actionProducer": {
        "name": "ShiftStart",
        "url": "https://wikipedia.org"
      },
      "location": {
        "businessUnit": "RTAZ",
        "site": "Marandoo",
        "department": "Site management",
        "workGroup": "Maintenance",
        "productiveUnit": "OFKYNSUDZOZKJAKB7J",
        "team": "Maintenance",
        "crew": "Maintenance"
      },
      "dueAt": "2024-11-26T02:34:47.000Z",
      "priority": "2",
      "status": "2",
      "owner": {
        "id": "3f53f806-fd6b-4bdd-9828-89a267875470",
        "name": "OmarZ",
        "email": null
      },
      "initiator": {
        "id": "3f53f806-fd6b-4bdd-9828-89a267875470",
        "name": "OmarZ",
        "email": null
      },
      "endorsedBy": [],
      "attachments": [],
      "tags": [],
      "allowAnonymousEdits": true,
      "comments": [],
      "createdAt": "2024-06-18T05:27:27.210Z",
      "updatedAt": "2024-06-18T05:31:03.839Z",
      "assignee": {
        "id": "undefined",
        "name": "Unknown user",
        "email": ""
      }
    }
  ],
  "totalCount": 213
}

Post Action Patch Action