Create Attributes

Search Attribute Values

client.Search.NewAttributes(ctx, body) (*ListarrayNextPageTokenstringSearchNewAttributesResponse, error)

post/api/v1/search/attributes

Search attributes based on filters specified in the request body.

Parameters

bodyAttributeTypeIDsfieldExcludeIDsfieldIDsfieldPageSizefieldPageTokenfieldQueryfieldValuefieldSearchNewAttributesParams

Hide ParametersShow Parameters

AttributeTypeIDsfield

optional

param.Field[[]string]

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

ExcludeIDsfield

optional

param.Field[[]string]

Exclude attributes with these ids from the search results.

IDsfield

optional

param.Field[[]string]

Include attributes with these ids in the search results.

PageSizefield

optional

param.Field[int64]

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

PageTokenfield

optional

param.Field[string]

The pageToken field.

Queryfield

optional

param.Field[string]

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

Valuefield

optional

param.Field[string]

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

Returns

SearchNewAttributesResponsestruct

SearchAttributeValuesResponse is the response for searching AttributeValues.

Hide ParametersShow Parameters

Listarray

optional

[]IDstringAttributeTypeIDstringCreatedAtTimeDeletedAtTimeUpdatedAtTimeValuestringAttributeValue

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.

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

UpdatedAtTime

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 Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Search.NewAttributes(context.TODO(), conductoronesdk.SearchNewAttributesParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.List)
}

200 Example

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