Create Attributes

Search Attribute Values

client.search.createAttributes(SearchCreateAttributesParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSearchCreateAttributesResponse

post/api/v1/search/attributes

Search attributes based on filters specified in the request body.

Parameters

bodyattributeTypeIdsunionexcludeIdsunionidsunionpageSizenumberpageTokenstringquerystringvaluestringSearchCreateAttributesParams

Hide ParametersShow Parameters

attributeTypeIdsunion

optional

Array<string> | null

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

excludeIdsunion

optional

Array<string> | null

Exclude attributes with these ids from the search results.

idsunion

optional

Array<string> | null

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

SearchCreateAttributesResponse

SearchAttributeValuesResponse is the response for searching AttributeValues.

Hide ParametersShow Parameters

listunion

optional

Array<idstringattributeTypeIdstringcreatedAtstringdeletedAtstringupdatedAtstringvaluestringAttributeValue> | null

The list of returned AttributeValues.

Hide ParametersShow Parameters

idstring

optional

The ID of the AttributeValue.

attributeTypeIdstring

optional

The ID of the AttributeType that this AttributeValue belongs to.

createdAtstring

optional

formatdate-time

deletedAtstring

optional

formatdate-time

updatedAtstring

optional

formatdate-time

valuestring

optional

The value of the AttributeValue. This is the string that will be displayed to the user.

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 TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.search.createAttributes();

console.log(response.list);

200 Example

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