Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Attribute

Search Attributes

Returns the organizations Attributes in paginated format. The pagination is handled with the startIndex and length keys in the request body. There are two filtering options within the body:

  • searchTerm field is searched within the titles of the Attributes
  • types field is a string array used for filtering the Attributes by type
    • type is the data type for the value of the attribute and can have three different values:
      • 1 -> text
      • 2 -> date
      • 3 -> number
post/attribute/search

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

startIndexinteger
lengthinteger
searchTermstring
typesinteger[]

Filter by attribute types (1=text, 2=date, 3=number)

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}