Diary

Returns a paginated list of diary summaries for a business unit, jobs, or foremen in a date range.

Securitybearer
Request
Request Body schema:

Set of filters for the request.

businessUnitId
required
string <uuid>

Business Unit Id.

jobIds
Array of strings or null <uuid>

List of Job Ids.

jobTagIds
Array of strings or null <uuid>

List of Job Filter Ids.

foremanIds
Array of strings or null <uuid>

List of Foreman Ids.

startDate
string or null <date-time>

Beginning local date (yyyy-MM-dd) of date range. Used with EndDate. Diaries whose dates fall within this date range will be included.

endDate
string or null <date-time>

End local date (yyyy-MM-dd) of date range. Used with StartDate. Diaries whose dates fall within this date range will be included.

cursor
string or null

Optional.
When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

limit
integer or null <int32>

The maximum number of results that should be returned.

Responses
post/api/v1/diaries/search
Request samples
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "foremanIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "cursor": "string",
  • "limit": 0
}
Response samples
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}

Creates or updates a diary record

Securitybearer
Request
Request Body schema:
jobId
required
string <uuid>

The job id.

foremanId
required
string <uuid>

The foreman id.

date
required
string <date-time>

The diary date.

lockedById
string or null <uuid>
lockedDateTime
string or null <date-time>

The date diary was submitted/sent.

revision
required
integer <int32>

Revision number

Array of objects or null (ApiTransactionTag)

Diary tags. Tag notes are limited to 500 characters.

note
string or null <= 7502 characters

The diary note.

workingConditions
string or null <= 200 characters

The diary working conditions.

Responses
put/api/v1/diaries
Request samples
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "foremanId": "69aa527e-0e0a-4642-a268-867ccfbc3591",
  • "date": "2019-08-24T14:15:22Z",
  • "lockedById": "fc6b25b2-cfb5-48cf-b1c0-8cb71fb8a61a",
  • "lockedDateTime": "2019-08-24T14:15:22Z",
  • "revision": 0,
  • "tags": [
    ],
  • "note": "string",
  • "workingConditions": "string"
}