{
"opencollection": "1.0.0",
"info": {
"name": "Openpath API Documentation auth orgs/sites API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "orgs/sites",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all sites",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites",
"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": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params"
},
{
"info": {
"name": "Create a site",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/sites",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-sos:w,o:w,s-o:w
__Endpoint name__: createSite"
},
{
"info": {
"name": "Describe a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"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}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-sos:w,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: describeSite"
},
{
"info": {
"name": "Update a site",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-sos:w,o:w,s-o:w
__Endpoint name__: updateSite"
},
{
"info": {
"name": "Delete a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,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,o{params.orgId}-sos:w
__Endpoint name__: deleteSite"
},
{
"info": {
"name": "Get location restriction for a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationRestriction",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"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:w,o:r,s-o:w,s-o:r
__Endpoint name__: getSiteLocationRestriction"
},
{
"info": {
"name": "Set location restriction for a site",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationRestriction",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w
__Endpoint name__: setSiteLocationRestriction"
},
{
"info": {
"name": "Delete location restriction for a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationRestriction",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w
__Endpoint name__: deleteSiteLocationRestriction"
},
{
"info": {
"name": "List location measurements for a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationMeasurements",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"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:w,o:r,s-o:w,s-o:r
__Endpoint name__: listSiteLocationMeasurements"
},
{
"info": {
"name": "List all users of a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/users",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"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}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listSiteUsers"
},
{
"info": {
"name": "List all groups of a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/groups",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"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}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: listSiteGroups"
},
{
"info": {
"name": "Describe a location measurement for a site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationMeasurements/:locationMeasurementId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "locationMeasurementId",
"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:w,o:r,s-o:w,s-o:r
__Endpoint name__: describeSiteLocationMeasurement"
},
{
"info": {
"name": "Delete a location measurement for a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationMeasurements/:locationMeasurementId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "locationMeasurementId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w
__Endpoint name__: deleteSiteLocationMeasurement"
},
{
"info": {
"name": "Add a user to a site",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/users/:userId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "userId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: setUserToSite"
},
{
"info": {
"name": "Remove a user from a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/users/:userId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "userId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: removeUserFromSite"
},
{
"info": {
"name": "Add a group to a site",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/groups/:groupId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "groupId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: setGroupToSite"
},
{
"info": {
"name": "Remove a group from a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/groups/:groupId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
},
{
"name": "groupId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: removeGroupFromSite"
},
{
"info": {
"name": "Set a site's users by replacing the entire set with this one",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/userIds",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: setSiteUserIds"
},
{
"info": {
"name": "Bulk-update a site's users",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/userIds",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: updateSiteUserIds"
},
{
"info": {
"name": "Set a site's groups by replacing the entire set with this one",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/groupIds",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: setSiteGroupIds"
},
{
"info": {
"name": "Bulk-update a site's groups",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/groupIds",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w
__Endpoint name__: updateSiteGroupIds"
},
{
"info": {
"name": "Set a location measurement for a site",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/orgs/:orgId/sites/:siteId/locationMeasurement",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "siteId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w
__Endpoint name__: setSiteLocationMeasurement"
}
]
}
],
"bundled": true
}