Получаване на групи обекти API

1. Описание

API за групи обекти е предназначен за извеждане на информация за групите обекти на потребителя.

2. Ограничения

1000 повторения/мин

3. Параметри на заявката

3.1. Получаване на всички групи обекти

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	+

Пример за отговор

{
    "continuation_token": 1,
    "items": [
        {
        "id": "id12312ds32",
        "name": "name",
        "objects_ids": [
            "dfdasdf564asdf",
            "jhggf+hj564gf6",
            "dsaf45d6asd546"
        ]
        },
        ...
        ]
}

3.2. Получаване на обекти, групирани по 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

Пример за отговор

{
    "id": "id12312ds32",
    "name": "name",
    "objects_ids": [
        "dfdasdf564asdf",
        "jhggf+hj564gf6",
        "dsaf45d6asd546"
    ]
}

4. Параметри на отговора

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