Create Attributes

Search Attribute Values

post/api/v1/search/attributes

Search attributes based on filters specified in the request body.

Body Parameters

attributeTypeIdsarray of string

optional

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

excludeIdsarray of string

optional

Exclude attributes with these ids from the search results.

idsarray of string

optional

Include attributes with these ids in the search results.

pageSizenumber

optional

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

formatint32

pageTokenstring

optional

The pageToken field.

querystring

optional

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

valuestring

optional

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

Returns

listarray of idstringattributeTypeIdstringcreatedAtstringdeletedAtstringupdatedAtstringvaluestringAttributeValue

optional

The list of returned AttributeValues.

nextPageTokenstring

optional

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.

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/search/attributes \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

200 Example

{
  "list": [
    {
      "id": "id",
      "attributeTypeId": "attributeTypeId",
      "value": "value"
    }
  ],
  "nextPageToken": "nextPageToken"
}