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

post

https://api.hcssapps.com/heavyjob/api/v1/diaries/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Set of filters for the request.

A POCO that represents a diary.

businessUnitId

uuid

required

Business Unit Id.

jobIds

array of uuids | null

List of Job Ids.

jobIds

jobTagIds

array of uuids | null

List of Job Filter Ids.

jobTagIds

foremanIds

array of uuids | null

List of Foreman Ids.

foremanIds

jobStatus

string

enum

Allowed:

startDate

date-time | null

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

endDate

date-time | null

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

modifiedSince

date-time | null

The date since the last update.

cursor

string | null

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

limit

int32 | null

The maximum number of results that should be returned.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK