v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Corrective Actions

Search Corrective Actions

Search for corrective actions that match the provided search terms.

Keywords are searched for in the assigned user first and last names, assigned company name, completed user first and last name, completed company name, sender first and last name, sender company name, the form submit key, action text, feed post content, and correction action response.

In addition, this endpoint provides additional parameters for filtering the results.

get/v1/corrective-action/

Query parameters

form_idinteger nullable

form_submit_idinteger nullable

feed_post_idinteger nullable

due_datestring date-time nullable

completed_startstring date-time nullable

completed_endstring date-time nullable

querystring nullable

skipinteger nullable

limitinteger nullable

sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable

date_cut_offstring date-time nullable

sort_column'updated_at' | 'created_at' | 'id'

Which column to sort on

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": [
    {
      "id": 1234,
      "feedPostId": 2,
      "assignedToUserId": 5,
      "assignedToCompanyId": 15,
      "completedByUserId": 6,
      "completedByCompanyId": 15,
      "completedOn": "2023-05-15T00:00:00",
      "feedPostResponseId": 234,
      "action": "Clear garbage in stairway",
      "dueDate": "2023-05-16T00:00:00",
      "createdAt": "2023-05-10T00:00:00",
      "updatedAt": "2023-05-16T00:00:00",
      "assignedToUserName": "John Doe",
      "assignedToCompanyName": "Wired Electricians",
      "completedByUserName": "Jane Doe",
      "completedByCompanyName": "Wired Electricians",
      "senderUserId": 7,
      "senderUserName": "Steve Stevenson",
      "senderCompanyId": 16,
      "senderCompanyName": "Building Builders",
      "responseUserId": 8,
      "responseComment": "Looks great",
      "formSubmitId": 345,
      "typeId": 10,
      "typeName": "Safety Hazard",
      "siteId": 3,
      "siteName": "Prime Site"
    }
  ]
}