COconductorone
Attribute

Search Attribute Values

Changed on

Search attributes based on filters specified in the request body.

post/api/v1/search/attributes

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/search/attributes
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

attributeTypeIdsstring[] nullable

The attribute type ids for what type of attributes to search for.

excludeIdsstring[] nullable

Exclude attributes with these ids from the search results.

idsstring[] nullable

Include attributes with these ids in the search results.

pageSizeinteger

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageTokenstring

The pageToken field.

querystring

Query the attributes with a fuzzy search on display name and description.

valuestring

Search for attributes with a case insensitive match on the attribute value which is the attribute name.

Response

SearchAttributeValuesResponse is the response for searching AttributeValues.

nextPageTokenstring

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Changes

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

  • 17f9f3bcedd5Revision changes
    • info

      endpoint added