Skip to main content
GET
List sample requests across styles

Headers

X-Delogue-Api
string

Query Parameters

StyleIds
integer<int64>[]

Restricts results to sample requests belonging to any of the given style identifiers.

Status
enum<string>

Restricts results to sample requests currently in the given status. To match several statuses at once, use statuses instead. Current status of the sample request as it moves through the request, send, receive and comment sample workflow.

Available options:
requested,
sent,
received,
commented,
cancelled,
confirmed,
planned
Statuses
enum<string>[]

Restricts results to sample requests currently in any of the given statuses. Repeat the parameter to match multiple statuses. When status is also supplied, the two sets are combined as a union.

Available options:
requested,
sent,
received,
commented,
cancelled,
confirmed,
planned
SampleTypeId
integer<int64>

Restricts results to sample requests raised for the given sample type.

DeadlineFrom
string<date-time>

Includes only sample requests whose deadline is on or after this date-time.

DeadlineTo
string<date-time>

Includes only sample requests whose deadline is strictly before this date-time.

EtdFrom
string<date-time>

Includes only sample requests whose estimated time of departure is on or after this date-time.

EtdTo
string<date-time>

Includes only sample requests whose estimated time of departure is strictly before this date-time.

IncludeArchived
boolean

When true, archived sample requests are included in the results. By default archived requests are excluded.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id.

pageSize

Number of results to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

Opaque keyset pagination token from a previous response. Mutually exclusive with filter, sort, pageSize and pageNumber.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.