{
"opencollection": "1.0.0",
"info": {
"name": "Openpath API Documentation auth orgs/entries API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "orgs/entries",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all entries",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
},
{
"name": "options",
"value": "",
"type": "query"
}
]
},
"docs": "Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.
__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{para"
},
{
"info": {
"name": "Create an entry",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/entries",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: createEntry"
},
{
"info": {
"name": "Describe an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "options",
"value": "",
"type": "query"
}
]
},
"docs": "Possible comma separated values for the options parameter include: withEffectiveLocationRestriction, withShadows. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.
__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-"
},
{
"info": {
"name": "Update an entry",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "ignoreWirelessLockHooks",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: updateEntry"
},
{
"info": {
"name": "Delete an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: deleteEntry"
},
{
"info": {
"name": "List all cameras of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/cameras",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-opvideoDevice:r,o{params.orgId}-opvideoDevice:w,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryCameras"
},
{
"info": {
"name": "List all third party reader - wiegands of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartWiegands",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryThirdPartyWiegands"
},
{
"info": {
"name": "List all wiegands of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/wiegands",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryWiegands"
},
{
"info": {
"name": "List all contactSensors of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/contactSensors",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryContactSensors"
},
{
"info": {
"name": "List all readers of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/readers",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryReaders"
},
{
"info": {
"name": "List all active users that have access to an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/users",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryUsers"
},
{
"info": {
"name": "List all active users, with their associated schedule(s), that have access to an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/userSchedules",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "options",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryUserSchedules"
},
{
"info": {
"name": "List all relays of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/relays",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryRelays"
},
{
"info": {
"name": "List all rexs of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/rexs",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryRexs"
},
{
"info": {
"name": "List all third party reader - OSDPs of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartyReaders",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryThirdPartyReaders"
},
{
"info": {
"name": "List all controls (readers, rexs, contact sensors, wiegands, relays) of an entry",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/entryControls",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listEntryControls"
},
{
"info": {
"name": "Get an entry's activity",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/reports/activity",
"headers": [
{
"name": "x-op-debug",
"value": ""
}
],
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "options",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: getEntryActivity"
},
{
"info": {
"name": "List all entries",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/entries/list",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.
__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{para"
},
{
"info": {
"name": "Remove any temporary override state from the entry's schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/revertTempState",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: revertEntryTempState"
},
{
"info": {
"name": "Remotely trigger an entry to identify itself via LED and buzzer of associated readers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/identify",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: remoteEntryIdentify"
},
{
"info": {
"name": "Add a temporary override state to the entry's schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/setTempState",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: setEntryTempState"
},
{
"info": {
"name": "Set a third party reader - wiegand to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartyWiegands/:thirdPartyWiegandId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "thirdPartyWiegandId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w
__Endpoint name__: setThirdPartyWiegandToEntry"
},
{
"info": {
"name": "Remove a third party reader - wiegand from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartyWiegands/:thirdPartyWiegandId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "thirdPartyWiegandId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeThirdPartyWiegandFromEntry"
},
{
"info": {
"name": "Set a wiegand to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/wiegands/:wiegandId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "wiegandId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w
__Endpoint name__: setWiegandToEntry"
},
{
"info": {
"name": "Remove a wiegand from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/wiegands/:wiegandId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "wiegandId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeWiegandFromEntry"
},
{
"info": {
"name": "Set a contactSensor to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/contactSensors/:contactSensorId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "contactSensorId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: setContactSensorToEntry"
},
{
"info": {
"name": "Remove a contactSensor from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/contactSensors/:contactSensorId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "contactSensorId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeContactSensorFromEntry"
},
{
"info": {
"name": "Set a reader to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/readers/:readerId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "readerId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w
__Endpoint name__: setReaderToEntry"
},
{
"info": {
"name": "Remove a reader from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/readers/:readerId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "readerId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeReaderFromEntry"
},
{
"info": {
"name": "Set a relay to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/relays/:relayId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "relayId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w
__Endpoint name__: setRelayToEntry"
},
{
"info": {
"name": "Remove a relay from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/relays/:relayId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "relayId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeRelayFromEntry"
},
{
"info": {
"name": "Set a rex to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/rexs/:rexId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "rexId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: setRexToEntry"
},
{
"info": {
"name": "Remove a rex from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/rexs/:rexId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "rexId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeRexFromEntry"
},
{
"info": {
"name": "Set a third party reader - OSDP to an entry",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartyReaders/:thirdPartyReaderId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "thirdPartyReaderId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w
__Endpoint name__: setThirdPartyReaderToEntry"
},
{
"info": {
"name": "Remove a third party reader - OSDP from an entry",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/entries/:entryId/thirdPartyReaders/:thirdPartyReaderId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "entryId",
"value": "",
"type": "path"
},
{
"name": "thirdPartyReaderId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o:w,s-o:w
__Endpoint name__: removeThirdPartyReaderFromEntry"
}
]
}
],
"bundled": true
}