Get agent attributes

Get an array of site agent attributes.

Method GET
URL /v1/attribute/{siteId}

Request parameters

All parameters are optional.

Parameter

Type

Description

Default value

columns (query)

string

Comma-separated list of columns to return. Supported values are:

  • id

  • name

  • value

id, name, value

filterActiveOnly (query)

Boolean

Filter active records or all records.

true

filterName (query)

string

Filter records by name.

 

max (query)

integer

Maximum number of records in response.

Maximum value: 1000.

10

offset (query)

string

Number of skipped records from the start.

0

order (query)

string

Order of records in result list. Supported values are:

  • ASC (ascending)

  • DESC (descending)

ASC

sort (query)

string

Field name used for sorting.

ASC

valueFilter (query)

string

Filter records by value.

 

Response codes

Status

Description

200

Body contains a paginated list of site agent attributes.

204

No site agent attribute records were found.

For a full list of supported response codes for UMAPI, see Response codes.

Samples

Note: Authentication is required to try out samples. For details, see API token authentication.

url        /portal/configuration/api/v1/attribute/10003715?columns=id%2Cname%2Cvalue&sort=name&order=ASC&max=1000&filterActiveOnly=true
Copy 
{
  "offset": 0,
  "max": 1000,
  "sort": "name",
  "order": "ASC",
  "total": 6,
  "records": [
    {
      "id": 2492,
      "name": "agentID",
      "value": "9876"
    },
    {
      "id": 2498,
      "name": "agentID",
      "value": "2323"
    },
    {
      "id": 15215,
      "name": "AgentLocation",
      "value": "Prague"
    },
    {
      "id": 6115,
      "name": "AgentLocation",
      "value": "DALLAS_TX"
    },
    {
      "id": 2463,
      "name": "AgentLocation",
      "value": "Makati Philippines"
    },
    {
      "id": 15220,
      "name": "AgentSkills",
      "value": "French"
    },
  ]
}