Skip to content

Retreive Labels

Request

Retreive the labels associated with one or more objects provided in the filterIds parameter. To return only active Labels, pass active in the filterStatuses parameter.

Data will be returned as an array of each object uuid provided in the filterIds parameter, along with the list of labelIds that are assigned to it.

NOT YET IMPLEMENTED

Security
OAuth2(Required scopes: readwrite) or apiKeyAuth
Bodyapplication/json
search_querystring, (JSON)

A JSON-encoded string containing the query options.

filter_idsArray of strings

Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored.

filter_statusesArray of strings

Provide the values in an array. If more than one value is given, they will be combined with AND. If no value is supplied, active is assumed.

filter_object_typestring

Provide a single Object Type.

Value:"person"
data_quantitystring

If caching data on the client side, the data_quantity=id_only|basic|complete option can be passed to manage the completeness of the data received and therefore rate limiting.

Default:"id_only"
Enum:"id_only""basic""complete"
page_sizeinteger, [ 1 .. 1000 ]

The number of results to return per page

Default:50
page_numberinteger

Which page of the results to return

sort_directionstring

The sort direction for the results

Enum:"asc""desc"
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/labels/select \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "search_query": "string",
    "filter_ids": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "filter_statuses": [
      "active"
    ],
    "filter_object_type": "person",
    "data_quantity": "id_only",
    "page_size": 50,
    "page_number": 0,
    "sort_direction": "asc"
  }'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Bodyapplication/json
statusstringrequired
Value:"success"
dataArray of objects(Label)required
metadataobject(ResponseMetadata)required

Present on every JSON response. For non-paginated operations, use page 1, total_pages 1, and total_records equal to the number of elements in data.

Response
{
  "status": "success",
  "data": [
    { … }
  ],
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "correlation_id": "string",
    "page": 1,
    "total_pages": 1,
    "total_records": 0
  }
}