M3m3ter-com
Commitments

Search Commitments

Changed on

Search for commitment entities.

This endpoint executes a search query for Commitments based on the user specified search criteria. The search query is customizable, allowing for complex nested conditions and sorting. The returned list of Commitments can be paginated for easier management.

get/organizations/{orgId}/commitments/search

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

searchQuerystring

Query for data using special syntax:

  • Query parameters should be delimited using $ (dollar sign).
  • Allowed comparators are:
    • (greater than) >
    • (greater than or equal to) >=
    • (equal to) :
    • (less than) <
    • (less than or equal to) <=
    • (match phrase/prefix) ~
  • Allowed parameters: startDate, endDate, contractId, accountId, productId, productIds, id, createdBy, dtCreated, lastModifiedBy, ids.
  • Query example:
    • searchQuery=startDate>2023-01-01$accountId:062085ab-a301-4f21-a081-411020864452.
    • This query is translated into: find commitments where the startDate is older than 2023-01-01 AND the accountId is equal to 062085ab-a301-4f21-a081-411020864452.

Note: Using the ~ match phrase/prefix comparator. For best results, we recommend treating this as a "starts with" comparator for your search query.

fromDocumentinteger

fromDocument for multi page retrievals.

pageSizeinteger

Number of Commitments to retrieve per page.

NOTE: If not defined, default is 10.

operator'AND' | 'OR'

Search Operator to be used while querying search.

sortBystring

Name of the parameter on which sorting is performed. Use any field available on the Commitment entity to sort by, such as accountId, endDate, and so on.

sortOrder'ASC' | 'DESC'

Sorting order.

Response

Return the Commitments that match the search criteria

nextTokenstring

Changes

  • 85c514abc692Revision changes
    • breaking

      the // response's property type changed from no type to object for status

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status