Pagination schemes for REST API responses - Documentation for BMC CMDB 20.02
David Mccullough news
In the following example of the response, the value of the "offset" field is the starting index of the first item in this page of results. The Default value is 0. The "limit" field defines the number of Instances to be retrieved. The default value is 500. When the "num_matches" flag is set to true, it returns the total number of matching instances. The default value is false.
curl -i -X GET -H 'Authorization: bearer <your_token>'
' name>:<port number>
/api/cmdb/v1.0/instances/
offset=0&limit=5&dataset_mask=0&attributes=Name,ShortDescription&num_matches=true'
URL: name>:<port number>
/api/cmdb/v1.0/instances/
offset=0&limit=5&dataset_mask=0&attributes=Name,ShortDescription&num_matches=true
HTTP/1.1 200 OK
{ "instances": [ { "instance_id": "OIGAA5V0HHF21AOP5NOBOP5NOBM5Y9", "class_name_key": { "name": "BMC_ComputerSystem", "namespace": "BMC.CORE" }, "attributes": { "Name": "instances_CS1", "ShortDescription": "n/a" }, "_links": { "self": [ { "href": " name>:<port number>
/api/cmdb/v1.0/instances/" } ] } }, { "instance_id": "OIGAA5V0HHF21AOP5NOBOP5NOBM5YK", "class_name_key": { "name": "BMC_ComputerSystem", "namespace": "BMC.CORE" }, "attributes": { "Name": "instances_CS2", "ShortDescription": "n/a" }, "_links": { "self": [ { "href": " name>:<port number>
/api/cmdb/v1.0/instances/" } ] } }, { "instance_id": "OIGAA5V0HHF21AOPOD1DOPOD1DDL6K", "class_name_key": { "name": "BMC_ComputerSystem", "namespace": "BMC.CORE" }, "attributes": { "Name": "instances_CS1", "ShortDescription": "n/a" }, "_links": { "self": [ { "href": " name>:<port number>
/api/cmdb/v1.0/instances/" } ] } }, { "instance_id": "OIGAA5V0HHF21AOPOD1DOPOD1DDL6L", "class_name_key": { "name": "BMC_ComputerSystem", "namespace": "BMC.CORE" }, "attributes": { "Name": "instances_CS2", "ShortDescription": "n/a" }, "_links": { "self": [ { "href": " name>:<port number>
/api/cmdb/v1.0/instances/" } ] } }, { "instance_id": "OIGAA5V0HHF21AOPOD1DOPOD1DDL6M", "class_name_key": { "name": "BMC_ComputerSystem", "namespace": "BMC.CORE" }, "attributes": { "Name": "instances_CS3", "ShortDescription": "n/a" }, "_links": { "self": [ { "href": " name>:<port number>
/api/cmdb/v1.0/instances/" } ] } } ], "num_matches": 292
}
