Job Message

List the chat messages on a job, newest first. Omit the body (or both ids) for the job-level chat; supply itemToMakeId and operationId together for one operation's chat.

post/api/jobs/{jobId}/messages/list

Path parameters

jobIdstring required

The job

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

itemToMakeIdstring nullable

Id of the item-to-make whose operation chat to list. Must be supplied together with operationId.

operationIdstring nullable

Id of the operation whose chat to list. Must be supplied together with itemToMakeId.

Response

The page of messages; an empty page when the chat has no messages yet

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes

Changed in 1 of the 23 revisions of this API.1