Config API Version 2 DGRP map items

List DGRP map items

Returns a list of DGRP map items.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dgrpMaps/{mapId}/mapItems

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
mapid (spec) - DGRP map ID

Response:

Returns a list of DGRP map items under the given {IGRP SPECIFIER} and {mapId} that the user has access to.

mapItemId (int) - DGRP map item ID.
igrp (int) - Installation ID.
mapId (int) - DGRP map ID.
itemKey (string) - Map item key
itemValue (string) - Map item value
updateDatetime (date) - Last updateDatetime

{"mapItemId":"1","igrp":"1","mapId":"1","itemKey":"default","itemValue":"1","updateDatetime":"0000-00-00 00:00:00"}
{"mapItemId":"2","igrp":"1","mapId":"1","itemKey":"CA","itemValue":"2","updateDatetime":"0000-00-00 00:00:00"}

Read DGRP map item

Returns a DGRP map item.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dgrpMaps/{mapId}/mapItems/{mapItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
mapid (spec) - DGRP map ID
mapItemId (spec) - DGRP map item ID

Response:

mapItemId (int) - DGRP map item ID.
igrp (int) - Installation ID.
mapId (int) - DGRP map ID.
itemKey (string) - Map item key
itemValue (string) - Map item value
updateDatetime (date) - Last updateDatetime

{"mapItemId":"1","igrp":"1","mapId":"1","itemKey":"default","itemValue":"1","updateDatetime":"0000-00-00 00:00:00"}

Create DGRP map item

Creates a DGRP map item.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dgrpMaps/{mapId}/mapItems

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
mapid (spec) - DGRP map ID

POST Params

itemKey (string) - Map item key
itemValue (int/array) - DGRP to map, can be an array of DGRPs

Response:

mapItemId (int) - DGRP map item ID.

HTTP 201 - CREATED

{"mapItemId":"1"}

Update DGRP map item

Updates a DGRP map item.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dgrpMaps/{mapId}/mapItems/{mapItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
mapid (spec) - DGRP map ID
mapItemId (spec) - DGRP map item ID

POST Params

itemKey (string) - Map item key
itemValue (int/array) - DGRP to map, can be an array of DGRPs

Response:

HTTP 200 - OK

Delete DGRP map item

Deletes a DGRP map item.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/dgrpMaps/{mapId}/mapItems/{mapItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
mapid (spec) - DGRP map ID
mapItemId (spec) - DGRP map item ID

Response:

HTTP 200 - OK