v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
RequestStatuses

Search request statuses

Search for one or more request statuses.

get/v1/RequestStatuses

Query parameters

search.request_status_idinteger[]

Query by request status identifier.

search.activeboolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

search.status_type'DRAFT' | 'CANCELED' | 'OPEN' | 'COMPLETE'

Query by kind of status.

search.namestring[]

Query by all or part of the name.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.