API za dohvaćanje grupa objekata

1. Opis

API za grupe objekata namijenjen je za ispis informacija o grupama objekata korisnika.

2. Ograničenja

1000 zahtjeva/min

3. Parametri zahtjeva

3.1. Dohvati sve grupe objekata

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	+

Primjer odgovora

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

3.2. Grupiraj objekte po ID-u

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

Primjer odgovora

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

4. Parametri odgovora

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