RErev-io
RequestStatuses

Search request statuses

Changed on

Search for one or more request statuses.

get/v1/RequestStatuses

Request

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' | 'PENDING_APPROVAL' | 'PENDING_SIGNATURE'

Query by kind of status.

search.namestring[]

Query by all or part of the name.

search.created_date_startstring date-time

Query by created date.

search.created_date_endstring date-time

Query by created date.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

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.

Changes

  • f175f5a3b11dRevision changes
    • warning

      added the new PENDING_APPROVAL enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new PENDING_APPROVAL enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new PENDING_APPROVAL enum value to the // response property for the response status (media type: text/html)

    • warning

      added the new PENDING_SIGNATURE enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new PENDING_SIGNATURE enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new PENDING_SIGNATURE enum value to the // response property for the response status (media type: text/html)

    • info

      added the new enum value PENDING_APPROVAL to the query request parameter search.status_type

    • info

      added the new enum value PENDING_SIGNATURE to the query request parameter search.status_type