1. Description
Objects groups API is dedicated to output information about user’s objects groups.
2. Limitations
- 1000 req/min
3. Request parameters
3.1. Get all objects groups
GET /object-groups?api_key=<...>&version=1&limit=<...>&continuation_token=<...> HTTP/1.1 Host: api.fm-track.com Content-Type: application/json;charset=UTF-8
| Parameter | Type | Description | Is required | Remarks |
|---|---|---|---|---|
| version | integer | version of API | + | At this moment we have only version=1 |
| limit | integer | Limits groups count in response. | - | Default -100. Maximum value - 1000 |
| continuation_token | integer | Continuation token | - | |
| api_key | string | User identification key | + |
Response example
{
"continuation_token": 1,
"items": [
{
"id": "id12312ds32",
"name": "name",
"objects_ids": [
"dfdasdf564asdf",
"jhggf+hj564gf6",
"dsaf45d6asd546"
]
},
...
]
}
3.2. Get objects group by ID
GET /object-groups/{objects_group_id}?api_key=<...>&version=1 HTTP/1.1
Host: api.fm-track.com
Content-Type: application/json;charset=UTF-8
| Parameter | Type | Description | Is required | Remarks |
|---|---|---|---|---|
| objects_group_id | string | Objects group identifier | + | |
| api_key | string | User identification key | + | |
| version | integer | version of API | + | At this moment we have only version=1 |
Response example
{
"id": "id12312ds32",
"name": "name",
"objects_ids": [
"dfdasdf564asdf",
"jhggf+hj564gf6",
"dsaf45d6asd546"
]
}
4. Response parameters
| Name | Type | Description |
|---|---|---|
| continuation_token | integer | Continuation token is sent when number of objects groups in response exceed limit |
| items | array | Container for all objects groups |
| id | string | Objects group ID |
| name | string | Objects group name |
| objects_ids | array | Container for all objects IDs, what belongs to this group |