{ "openapi" : "3.0.1", "info" : { "contact" : { "email" : "support@rhombus.com", "url" : "https://developer.rhombus.com" }, "description" : "This API is for use by Rhombus customers and partners.\n\n## Authentication\n\nAll requests require two headers:\n- `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.\n- `x-auth-apikey` — Your Rhombus API key.\n\nExample:\n```\nPOST /api/camera/getMinimalCameraStateList\nx-auth-scheme: api-token\nx-auth-apikey: YOUR_API_KEY\nContent-Type: application/json\n```", "title" : "Rhombus API", "version" : "1.0" }, "externalDocs" : { "description" : "Rhombus Developer Documentation", "url" : "https://developer.rhombus.com" }, "servers" : [ { "description" : "Production Server", "url" : "https://api2.rhombussystems.com" } ], "security" : [ { "ApiKeyAuth" : [ ] } ], "paths" : { "/api/accesscontrol/addUsersToAccessControlGroup" : { "post" : { "description" : "Adds specified users to an access control group", "operationId" : "addUsersToAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_AddUsersToOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_AddUsersToOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Add users to access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/assignAccessControlCredential" : { "post" : { "description" : "Assign a currently unassigned credential to a user", "operationId" : "assignAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_AssignAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_AssignAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/create35BitCorp1000StdCredential" : { "post" : { "description" : "Create a HID Corp1000 Standard 35 bit credential", "operationId" : "create35BitCorp1000StdCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_Create35BitCorp1000StdCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_Create35BitCorp1000StdCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create an HID Corp1000 Standard 35 bit credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/create48BitCorp1000StdCredential" : { "post" : { "description" : "Create a HID Corporate 1000 Standard 48 bit credential", "operationId" : "create48BitCorp1000StdCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_Create48BitCorp1000StdCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_Create48BitCorp1000StdWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create an HID Corp1000 Standard 48 bit credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createAccessControlCredentialByHexValueAndType" : { "post" : { "description" : "Create a credential based on a hex value and credential type. Useful if you see an unauthorized badge event, know its type and want to import it", "operationId" : "createAccessControlCredentialByHexValueAndType", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create access control credential by hex value and type", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createAccessControlGroup" : { "post" : { "description" : "Creates an access control group", "operationId" : "createAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_CreateOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_CreateOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createAccessGrant" : { "post" : { "description" : "Create a location access grant", "operationId" : "createAccessGrant", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_CreateAccessGrantWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_CreateAccessGrantWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create access grant", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createAccessRevocation" : { "post" : { "description" : "Create a location access revocation", "operationId" : "createAccessRevocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_CreateAccessRevocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_CreateAccessRevocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create access revocation", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createRhombusSecureCsnCredential" : { "post" : { "description" : "Create a rhombus secure csn credential (Rhombus Badge)", "operationId" : "createRhombusSecureCsnCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create Rhombus Secure CSN credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createStandardCsnCredential" : { "post" : { "description" : "Create a standard csn credential (Third Party Badge)", "operationId" : "createStandardCsnCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateStandardCsnCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateStandardCsnCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create standard CSN credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegand64BitRawCredential" : { "post" : { "description" : "Create a 64bit raw wiegand credential. Used when an explicit endpoint for the wiegand format is not otherwise defined.", "operationId" : "createWiegand64BitRawCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create 64-bit raw Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegandCredential" : { "post" : { "deprecated" : true, "description" : "Create a wiegand credential", "operationId" : "createWiegandCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegandD10202Credential" : { "post" : { "description" : "Create a D10202 wiegand credential", "operationId" : "createWiegandD10202Credential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandD10202CredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandD10202CredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create D10202 Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegandH10301Credential" : { "post" : { "description" : "Create a H10301 wiegand credential", "operationId" : "createWiegandH10301Credential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10301CredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10301CredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create H10301 Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegandH10302Credential" : { "post" : { "description" : "Create a H10302 wiegand credential", "operationId" : "createWiegandH10302Credential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10302CredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10302CredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create H10302 Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/createWiegandH10304Credential" : { "post" : { "description" : "Create a H10304 wiegand credential", "operationId" : "createWiegandH10304Credential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10304CredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10304CredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create H10304 Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/deleteAccessControlCredential" : { "post" : { "description" : "Delete an access control credential. It is recommended to revoke a credential rather than delete it to preserve credential history", "operationId" : "deleteAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_DeleteAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_DeleteAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/deleteAccessControlGroup" : { "post" : { "description" : "Delete an access control group", "operationId" : "deleteAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_DeleteOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_DeleteOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/deleteLocationAccessGrant" : { "post" : { "description" : "Deletes a location access grant", "operationId" : "deleteLocationAccessGrant", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_DeleteLocationAccessGrantWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_DeleteLocationAccessGrantWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete location access grant", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/deleteLocationAccessRevocation" : { "post" : { "description" : "Deletes a location access revocation", "operationId" : "deleteLocationAccessRevocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete location access revocation", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/deleteUnassignedAccessControlCredential" : { "post" : { "description" : "Delete an unassigned access control credential. The credential must be unassigned (revoked) before this method can be called. History of the credential is maintained but it will no longer be returned as an unassigned credential.", "operationId" : "deleteUnassignedAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete unassigned access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlCredentialByGuestPass" : { "post" : { "description" : "Find all access control credentials assigned to the specified guest pass", "operationId" : "findAccessControlCredentialByGuestPass", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control credentials by guest pass", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlCredentialByOrg" : { "post" : { "description" : "Find all access control credentials in the org", "operationId" : "findAccessControlCredentialByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control credentials by org", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlCredentialByUser" : { "post" : { "description" : "Find all access control credentials for the specified user", "operationId" : "findAccessControlCredentialByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control credentials by user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlCredentialByUsers" : { "post" : { "description" : "Find all access control credentials for the specified users", "operationId" : "findAccessControlCredentialByUsers", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByUsersWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByUsersWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control credentials by users", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlGroupByExactName" : { "post" : { "description" : "Retrieve the access control group with the specified name", "operationId" : "findAccessControlGroupByExactName", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByExactNameWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByExactNameWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control group by exact name", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlGroupMembershipsByUser" : { "post" : { "description" : "Find all access control group memberships by user", "operationId" : "findAccessControlGroupMembershipsByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupMembershipsByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupMembershipsByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control group memberships by user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlGroupsByNamePrefix" : { "post" : { "description" : "Retrieve all access control groups with a name starting with the specified prefix", "operationId" : "findAccessControlGroupsByNamePrefix", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByNamePrefixWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByNamePrefixWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control groups by name prefix", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlGroupsByOrg" : { "post" : { "description" : "Retrieve all access control groups defined in the org", "operationId" : "findAccessControlGroupsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control groups by org", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAccessControlGroupsByUserMembership" : { "post" : { "description" : "Find all access control groups a user belongs to", "operationId" : "findAccessControlGroupsByUserMembership", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByUserMembershipWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindOrgGroupsByUserMembershipWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access control groups by user membership", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findAllUsersForAccessControlGroup" : { "post" : { "description" : "Find all users belonging to an access control group", "operationId" : "findAllUsersForAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindAllUsersForOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_FindAllUsersForOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all users for access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findCredentialHistoryByCredentialHexValue" : { "post" : { "description" : "Retrieves all credentials that have owned the credential hex value. Expect at most 1 valid/active credential and the rest are revoked", "operationId" : "findCredentialHistoryByCredentialHexValue", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find credential history by credential hex value", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findCredentialHistoryByCredentialValue" : { "post" : { "description" : "Retrieves all credentials that have owned the credential value.", "operationId" : "findCredentialHistoryByCredentialValue", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find credential history by credential value", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findCredentialHistoryByUser" : { "post" : { "description" : "Retrieves all credentials both current and revoked that were at some point assigned to the specified user", "operationId" : "findCredentialHistoryByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_FindCredentialHistoryByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find credential history by user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByAccessControlledDoor" : { "post" : { "description" : "Finds location access grants by the specified access controlled door", "operationId" : "findLocationAccessGrantsByAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by access controlled door", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByAccessControlledElevatorLanding" : { "post" : { "description" : "Finds location access grants by the specified access controlled elevator landing", "operationId" : "findLocationAccessGrantsByAccessControlledElevatorLanding", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by access controlled elevator landing", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByDoorLabel" : { "post" : { "description" : "Finds location access grants by the specified door label", "operationId" : "findLocationAccessGrantsByDoorLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by door label", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByGroup" : { "post" : { "description" : "Finds location access grants by the specified group", "operationId" : "findLocationAccessGrantsByGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByLocation" : { "post" : { "description" : "Finds location access grants by the specified location", "operationId" : "findLocationAccessGrantsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by location", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByLocationAndUser" : { "post" : { "description" : "Finds location access grants by the specified location and user", "operationId" : "findLocationAccessGrantsByLocationAndUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by location and user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByOrg" : { "post" : { "description" : "Finds all location access grants in the org", "operationId" : "findLocationAccessGrantsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by org", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessGrantsByUser" : { "post" : { "description" : "Finds location access grants by the specified user", "operationId" : "findLocationAccessGrantsByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access grants by user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByAccessControlledDoor" : { "post" : { "description" : "Finds location access revocations by the specified access controlled door", "operationId" : "findLocationAccessRevocationsByAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by access controlled door", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByAccessControlledElevatorLanding" : { "post" : { "description" : "Finds location access revocations by the specified access controlled elevator landing", "operationId" : "findLocationAccessRevocationsByAccessControlledElevatorLanding", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by access controlled elevator landing", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByDoorLabel" : { "post" : { "description" : "Finds location access revocation by the specified door label", "operationId" : "findLocationAccessRevocationsByDoorLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by door label", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByGroup" : { "post" : { "description" : "Finds location access revocations by the specified group", "operationId" : "findLocationAccessRevocationsByGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByOrg" : { "post" : { "description" : "Finds all location access revocations in the org", "operationId" : "findLocationAccessRevocationsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by org", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/findLocationAccessRevocationsByUser" : { "post" : { "description" : "Finds location access revocations by the specified user", "operationId" : "findLocationAccessRevocationsByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location access revocations by user", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/getAccessControlCredentialDetails" : { "post" : { "description" : "Retrieves an access control credential of any type, including sensitive details, by UUID.", "operationId" : "getAccessControlCredentialDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetAccessControlCredentialDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetAccessControlCredentialDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get access control credential details", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/getLocationAccessGrant" : { "post" : { "description" : "Retrieve a location access grant by id", "operationId" : "getLocationAccessGrant", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_GetLocationAccessGrantWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_GetLocationAccessGrantWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get location access grant", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/getLocationAccessRevocation" : { "post" : { "description" : "Retrieve a location access revocation by id", "operationId" : "getLocationAccessRevocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_GetLocationAccessRevocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_GetLocationAccessRevocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get location access revocation", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/getRhombusSecureCsnCredentialDetails" : { "post" : { "deprecated" : true, "description" : "Retrieves a rhombus secure csn credential including sensitive details. Deprecated: use getAccessControlCredentialDetails.", "operationId" : "getRhombusSecureCsnCredentialDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Rhombus Secure CSN credential details", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/getStandardCsnCredentialDetails" : { "post" : { "deprecated" : true, "description" : "Retrieves a standard csn credential including sensitive details. Deprecated: use getAccessControlCredentialDetails.", "operationId" : "getStandardCsnCredentialDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get standard CSN credential details", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/lockdownPlan/activateLockdownForLocation" : { "post" : { "description" : "Activate lockdown for the specified location", "operationId" : "activateLockdownForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Activate lockdown for the specified location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/createLocationLockdownPlan" : { "post" : { "description" : "Create location lockdown plan", "operationId" : "createLocationLockdownPlan", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create location lockdown plan", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation" : { "post" : { "description" : "Create (or update if ruleUuid is provided) a lockdown rule for the specified location", "operationId" : "createLockdownRuleForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create lockdown rule for location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/deactivateLockdownForLocation" : { "post" : { "description" : "Deactivate lockdown for the specified location", "operationId" : "deactivateLockdownForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Deactivate lockdown for the specified location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/deleteLocationLockdownState" : { "post" : { "description" : "Disables tracking lockdown state for the specified location", "operationId" : "deleteLocationLockdownState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete location lockdown state", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/deleteLockdownPlan" : { "post" : { "description" : "Delete lockdown plan", "operationId" : "deleteLockdownPlan", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete lockdown plan", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/deleteLockdownRuleForLocation" : { "post" : { "description" : "Delete a lockdown rule for the specified location", "operationId" : "deleteLockdownRuleForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete lockdown rule for location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/disableLockdownTestModeForLocation" : { "post" : { "description" : "Disable test mode of lockdown for the specified location", "operationId" : "disableLockdownTestModeForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Disable test mode of lockdown for the specified location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/enableLockdownTestModeForLocation" : { "post" : { "description" : "Enable test mode of lockdown for the specified location", "operationId" : "enableLockdownTestModeForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Enable test mode of lockdown for the specified location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/findLocationLockdownEvents" : { "post" : { "description" : "Retrieve a list of lockdown events for the specified location", "operationId" : "findLocationLockdownEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location lockdown events", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/findLocationLockdownStates" : { "post" : { "description" : "Finds the state of all lockdowns for the org", "operationId" : "findLocationLockdownStates", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find location lockdown states", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/findLockdownPlans" : { "post" : { "description" : "Find lockdown plans in the org", "operationId" : "findLockdownPlans", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLockdownPlansWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLockdownPlansWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find lockdown plans in the org", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/findLockdownPlansByLocation" : { "post" : { "description" : "Find lockdown plans for the specified location", "operationId" : "findLockdownPlansByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find lockdown plans for the specified location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/getLockdownPlan" : { "post" : { "description" : "Get lockdown plan", "operationId" : "getLockdownPlan", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetLockdownPlanWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetLockdownPlanWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get lockdown plan", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/getLockdownRulesForLocation" : { "post" : { "description" : "Get lockdown activation / deactivation rules for a location", "operationId" : "getLockdownRulesForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get lockdown rules for location", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState" : { "post" : { "description" : "Retrieves an existing lockdown state or creates one for the specified location", "operationId" : "getOrCreateLocationLockdownState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get or create location lockdown state", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/lockdownPlan/updateLocationLockdownPlan" : { "post" : { "description" : "Update location lockdown plan", "operationId" : "updateLocationLockdownPlan", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update location lockdown plan", "tags" : [ "Lockdown Plan Webservice" ] } }, "/api/accesscontrol/removeUsersFromAccessControlGroup" : { "post" : { "description" : "Removes specified users from an access control group", "operationId" : "removeUsersFromAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_RemoveUsersFromOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_RemoveUsersFromOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove users from access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/revokeAccessControlCredential" : { "post" : { "description" : "Revokes an access control credential. Unlike suspension this will give up its claim on the credential value allowing another cred to claim it as its identifier", "operationId" : "revokeAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_RevokeAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_RevokeAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/suspendAccessControlCredential" : { "post" : { "description" : "Mark an access control credential as suspended", "operationId" : "suspendAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_SuspendAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_SuspendAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Suspend access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/unlockAccessControlledDoor" : { "post" : { "description" : "Unlock an access controlled door", "operationId" : "unlockAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_BaseUnlockAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock access controlled door", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/unsuspendAccessControlCredential" : { "post" : { "description" : "Mark an access control credential as no longer suspended", "operationId" : "unsuspendAccessControlCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UnsuspendAccessControlCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UnsuspendAccessControlCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unsuspend access control credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateAccessControlGroup" : { "post" : { "description" : "Updates an access control group's meta information like name and description", "operationId" : "updateAccessControlGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_UpdateOrgGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group_UpdateOrgGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update access control group", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateAccessGrant" : { "post" : { "description" : "Updates a location access grant", "operationId" : "updateAccessGrant", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_UpdateAccessGrantWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessgrant_UpdateAccessGrantWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update access grant", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateAccessRevocation" : { "post" : { "description" : "Updates a location access revocation", "operationId" : "updateAccessRevocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_UpdateAccessRevocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_accessrevocation_UpdateAccessRevocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update access revocation", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateRhombusSecureCsnCredential" : { "post" : { "description" : "Update a rhombus secure csn credential (Rhombus Badge)", "operationId" : "updateRhombusSecureCsnCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Rhombus Secure CSN credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateRhombusSecureMobileCredential" : { "post" : { "description" : "Update a rhombus secure mobile credential (RhombusKey App w/ BLE or NFC)", "operationId" : "updateRhombusSecureMobileCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Rhombus Secure mobile credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateStandardCsnCredential" : { "post" : { "description" : "Update a standard csn credential (Third Party Badge)", "operationId" : "updateStandardCsnCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateStandardCsnCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateStandardCsnCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update standard CSN credential", "tags" : [ "Access Control Webservice" ] } }, "/api/accesscontrol/updateWiegandCredential" : { "post" : { "description" : "Update a wiegand credential (Third Party Badge)", "operationId" : "updateWiegandCredential", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateWiegandCredentialWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_UpdateWiegandCredentialWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Wiegand credential", "tags" : [ "Access Control Webservice" ] } }, "/api/alertmonitoring/cancelThreatCase" : { "post" : { "deprecated" : true, "description" : "Cancel a threat case in alert monitoring.", "operationId" : "cancelThreatCase", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CancelThreatCaseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CancelThreatCaseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Cancel threat case", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/createCustomPinForLocation" : { "post" : { "deprecated" : true, "description" : "Create a custom PIN for alert monitoring at a specific location.", "operationId" : "createCustomPinForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CreateCustomPinForNoonlightWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CreateCustomPinForNoonlightWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create custom PIN for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/createPinForLocation" : { "post" : { "deprecated" : true, "description" : "Create a PIN for alert monitoring at a specific location.", "operationId" : "createPinForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CreatePinForNoonlightWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_CreatePinForNoonlightWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create PIN for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/deletePinForLocation" : { "post" : { "deprecated" : true, "description" : "Delete a PIN for alert monitoring at a specific location.", "operationId" : "deletePinForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DeletePinForNoonlightWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DeletePinForNoonlightWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete PIN for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/disableMonitoringForLocation" : { "post" : { "description" : "Disable alert monitoring for a specific location.", "operationId" : "disableMonitoringForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DisableLocationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DisableLocationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Disable monitoring for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/dismissThreatCase" : { "post" : { "deprecated" : true, "description" : "Dismiss a threat case in alert monitoring.", "operationId" : "dismissThreatCase", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DismissThreatCaseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_DismissThreatCaseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Dismiss threat case", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/enableMonitoringForLocation" : { "post" : { "description" : "Enable alert monitoring for a specific location.", "operationId" : "enableMonitoringForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_EnableLocationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_EnableLocationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Enable monitoring for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/escalateThreatCaseToAlarm" : { "post" : { "deprecated" : true, "description" : "Escalate a threat case to an alarm for alert monitoring.", "operationId" : "escalateThreatCaseToAlarm", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_EscalateThreatCaseToAlarmWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_EscalateThreatCaseToAlarmWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Escalate threat case to alarm", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/getAlertMonitoringSettingsForLocation" : { "post" : { "deprecated" : true, "description" : "Retrieve alert monitoring settings by location.", "operationId" : "getAlertMonitoringSettingsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_GetNoonlightSettingsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_GetNoonlightSettingsForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get alert monitoring settings for location", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/locationStatus" : { "post" : { "description" : "Retrieve summary of the alarm monitoring status for the specified location", "operationId" : "locationStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_LocationStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_LocationStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get location status", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/alertmonitoring/orgStatus" : { "post" : { "description" : "Retrieve summary of the alarm monitoring status for all locations", "operationId" : "orgStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_OrgStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Alertmonitoring_OrgStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization status", "tags" : [ "Alert Monitoring Webservice" ] } }, "/api/audiogateway/delete" : { "post" : { "description" : "Remove an audio gateway from organization", "operationId" : "deleteAudioGateway", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_DeleteAudioGatewayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_DeleteAudioGatewayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete audio gateway", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getAudioSeekpoints" : { "post" : { "description" : "Get audio seek points", "operationId" : "getAudioSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetAudioSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetAudioSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio seek points", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getConfig" : { "post" : { "description" : "Get an audio gateway config", "operationId" : "getAudioGatewayConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetAudioGatewayConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetAudioGatewayConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio gateway config", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getFullAudioGatewayState" : { "post" : { "description" : "Get detailed information about state of specified audio gateway", "operationId" : "getFullAudioGatewayState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetFullAudioGatewayStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetFullAudioGatewayStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get full audio gateway state", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getMediaUris" : { "post" : { "description" : "Get media uris for audio gateway to retrieve footage", "operationId" : "getAudioGatewayMediaUris", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetMediaUrisWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetMediaUrisWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get media URIs for audio gateway", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getMinimalAudioGatewayStateList" : { "post" : { "description" : "Get basic state information for all audio gateways", "operationId" : "getMinimalAudioGatewayStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetMinimalAudioGatewayStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_GetMinimalAudioGatewayStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal audio gateway state list", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getPresenceWindows" : { "post" : { "description" : "Get stored video information for an audio gateway", "operationId" : "getAudioGatewayPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio gateway presence windows", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/getUptimeWindows" : { "post" : { "description" : "Get uptime information for an audio gateway", "operationId" : "getAudioGatewayUptimeWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio gateway uptime windows", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/updateConfig" : { "post" : { "description" : "Update config for audio gateway", "operationId" : "updateAudioGatewayConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_UpdateAudioGatewayConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_UpdateAudioGatewayConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update audio gateway config", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audiogateway/updateDetails" : { "post" : { "description" : "Update details for audio gateway. Note: uuid is a required field", "operationId" : "updateAudioGatewayDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_UpdateAudioGatewayDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audiogateway_UpdateAudioGatewayDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update audio gateway details", "tags" : [ "AudioGateway Webservice" ] } }, "/api/audioplayback/cancelLoopingAudioPlayback" : { "post" : { "description" : "Cancel any currently playing looping audio for an audio device", "operationId" : "cancelLoopingAudioPlayback", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_CancelLoopingAudioPlaybackWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_CancelLoopingAudioPlaybackWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Cancel looping audio playback", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/audioplayback/deleteAudioUploadMetadata" : { "post" : { "description" : "Delete an uploaded audio clip metadata", "operationId" : "deleteAudioUploadMetadata", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_DeleteAudioUploadMetadataWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_DeleteAudioUploadMetadataWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete audio upload metadata", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/audioplayback/getAudioUploadMetadataForOrg" : { "post" : { "description" : "Get list of uploaded audio clip metadata", "operationId" : "getAudioUploadMetadataForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_GetAudioUploadMetadataForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_GetAudioUploadMetadataForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio upload metadata for organization", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/audioplayback/playAudioUpload" : { "post" : { "description" : "Play an uploaded audio clip through an audio device", "operationId" : "playAudioUpload", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_PlayAudioUploadWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_PlayAudioUploadWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Play audio upload", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/audioplayback/updateAudioUploadMetadata" : { "post" : { "description" : "Update an uploaded audio clip metadata", "operationId" : "updateAudioUploadMetadata", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_UpdateAudioUploadMetadataWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_UpdateAudioUploadMetadataWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update audio upload metadata", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/audioplayback/uploadAudioText" : { "post" : { "description" : "Upload text to synthesize audio", "operationId" : "uploadAudioText", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_UploadAudioTextWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audioplayback_UploadAudioTextWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload text to synthesize audio", "tags" : [ "AudioPlayback Webservice" ] } }, "/api/badgereader/delete" : { "post" : { "description" : "Remove the badge reader from the organization", "operationId" : "deleteBadgeReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Badgereader_DeleteBadgeReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Badgereader_DeleteBadgeReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete badge reader", "tags" : [ "Badge Reader Webservice" ] } }, "/api/badgereader/reboot" : { "post" : { "description" : "Reboot the specified badge reader", "operationId" : "rebootBadgeReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Badgereader_RebootBadgeReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reboot badge reader", "tags" : [ "Badge Reader Webservice" ] } }, "/api/ble/getBaseStations" : { "post" : { "description" : "Retrieve list of available base stations for BLE sensors", "operationId" : "getBaseStations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Ble_GetBaseStationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Ble_GetBaseStationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get base stations", "tags" : [ "BLE Webservice" ] } }, "/api/button/createRuleForButton" : { "post" : { "description" : "Create rule for a button sensor.", "operationId" : "createRuleForButton", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_CreateRuleForButtonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_CreateRuleForButtonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create rule for button", "tags" : [ "Button Webservice" ] } }, "/api/button/deleteRuleForButton" : { "post" : { "description" : "Delete rule for a button sensor.", "operationId" : "deleteRuleForButton", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_DeleteRuleForButtonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_DeleteRuleForButtonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rule for button", "tags" : [ "Button Webservice" ] } }, "/api/button/getButtonPressEventsForSensor" : { "post" : { "description" : "Get list of button press events for button sensor", "operationId" : "getButtonPressEventsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetButtonPressEventsForSensorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetButtonPressEventsForSensorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get button press events for sensor", "tags" : [ "Button Webservice" ] } }, "/api/button/getButtonRulesForOrg" : { "post" : { "description" : "Get rules for all buttons in an org.", "operationId" : "getButtonRulesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetButtonRulesForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetButtonRulesForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get button rules for organization", "tags" : [ "Button Webservice" ] } }, "/api/button/getMinimalButtonStateList" : { "post" : { "description" : "Get basic state information for all button sensors", "operationId" : "getMinimalButtonStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetMinimalButtonStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetMinimalButtonStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal button state list", "tags" : [ "Button Webservice" ] } }, "/api/button/getRulesForButton" : { "post" : { "description" : "Get all rules for a button sensor.", "operationId" : "getRulesForButton", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetRulesForButtonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_GetRulesForButtonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rules for button", "tags" : [ "Button Webservice" ] } }, "/api/button/updateConfig" : { "post" : { "description" : "Update config for a button sensor.", "operationId" : "updateButtonConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_UpdateButtonConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update button config", "tags" : [ "Button Webservice" ] } }, "/api/button/updateDetails" : { "post" : { "description" : "Update details for a button sensor.", "operationId" : "updateButtonDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Button_UpdateButtonDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateDeviceDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update button details", "tags" : [ "Button Webservice" ] } }, "/api/camera/calibrateFloorplanProjection" : { "post" : { "description" : "Generate the homography to project detections onto a floorplan.", "operationId" : "cameraCalibrateFloorplanProjection", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Calibrate floorplan projection", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createCustomFootageSeekpoints" : { "post" : { "description" : "Create custom activity seekpoints for a specified camera", "operationId" : "createCustomFootageSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateCustomFootageSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateFootageSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create custom footage seekpoints", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createFootageBoundingBoxes" : { "post" : { "description" : "Create an activity bounding box for specified camera", "operationId" : "createFootageBoundingBoxes", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateFootageBoundingBoxesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateFootageBoundingBoxesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create footage bounding boxes", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createProtectedSharedLiveVideoStream" : { "post" : { "description" : "Share a password protected live video stream for a camera", "operationId" : "createProtectedSharedLiveVideoStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedLiveVideoStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedLiveVideoStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create protected shared live video stream", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createProtectedSharedVideoWall" : { "post" : { "description" : "Share a password protected video wall", "operationId" : "createProtectedSharedVideoWall", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create protected shared video wall", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createRawHttpStream" : { "post" : { "description" : "Create a raw HTTP stream for a camera", "operationId" : "createCameraRawHttpStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create camera raw HTTP stream", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createSharedLiveVideoStream" : { "post" : { "description" : "Share an unprotected live video stream for a camera", "operationId" : "createCameraSharedLiveVideoStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedLiveVideoStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedLiveVideoStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create shared live video stream", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createSharedVideoWall" : { "post" : { "description" : "Share an unprotected video wall", "operationId" : "createSharedVideoWall", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateSharedVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create shared video wall", "tags" : [ "Camera Webservice" ] } }, "/api/camera/createVideoWall" : { "post" : { "description" : "Create a video wall for user", "operationId" : "createVideoWall", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CreateVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create video wall", "tags" : [ "Camera Webservice" ] } }, "/api/camera/delete" : { "post" : { "description" : "Remove a camera from organization", "operationId" : "deleteCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete camera", "tags" : [ "Camera Webservice" ] } }, "/api/camera/deleteCustomFootageSeekpoints" : { "post" : { "description" : "Delete custom seekpoints for specified cameras", "operationId" : "deleteCustomFootageSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete custom footage seekpoints", "tags" : [ "Camera Webservice" ] } }, "/api/camera/deleteRawHttpStream" : { "post" : { "description" : "Delete a raw HTTP stream for a camera", "operationId" : "deleteCameraRawHttpStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete camera raw HTTP stream", "tags" : [ "Camera Webservice" ] } }, "/api/camera/deleteSharedLiveVideoStream" : { "post" : { "description" : "Remove a shared live stream from camera", "operationId" : "deleteSharedLiveVideoStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteSharedLiveVideoStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeleteSharedLiveVideoStreamForDeviceResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete shared live video stream", "tags" : [ "Camera Webservice" ] } }, "/api/camera/deleteSharedVideoWall" : { "post" : { "description" : "Remove a shared video wall", "operationId" : "deleteSharedVideoWall", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteSharedVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteSharedVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete shared video wall", "tags" : [ "Camera Webservice" ] } }, "/api/camera/deleteVideoWall" : { "post" : { "description" : "Delete a video wall", "operationId" : "deleteVideoWall", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_DeleteVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete video wall", "tags" : [ "Camera Webservice" ] } }, "/api/camera/erase" : { "post" : { "description" : "Wipes the SD card on a camera", "operationId" : "eraseCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_EraseCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_EraseCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Erase camera", "tags" : [ "Camera Webservice" ] } }, "/api/camera/findAllRawHttpStreams" : { "post" : { "description" : "Get a list of all cameras raw HTTP streams", "operationId" : "findAllCameraRawHttpStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all camera raw HTTP streams", "tags" : [ "Camera Webservice" ] } }, "/api/camera/findAllSharedLiveVideoStreams" : { "post" : { "description" : "Get list of all shared live streams", "operationId" : "findAllSharedLiveVideoStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindAllSharedLiveVideoStreamsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindAllSharedLiveVideoStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all shared live video streams", "tags" : [ "Camera Webservice" ] } }, "/api/camera/findSharedLiveVideoStreams" : { "post" : { "description" : "Get list of all shared live streams for camera", "operationId" : "findCameraSharedLiveVideoStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindSharedLiveVideoStreamsForWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindSharedLiveVideoStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find camera shared live video streams", "tags" : [ "Camera Webservice" ] } }, "/api/camera/findSharedVideoWalls" : { "post" : { "description" : "Get list of all shares for a video wall", "operationId" : "findSharedVideoWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindSharedVideoWallsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_FindSharedVideoWallsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find shared video walls", "tags" : [ "Camera Webservice" ] } }, "/api/camera/generateBatchRegistrationInfo" : { "post" : { "description" : "Create camera registration information for QR code generation", "operationId" : "generateBatchRegistrationInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GenerateBatchRegistrationInfoRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GenerateBatchRegistrationInfoResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate batch registration info", "tags" : [ "Camera Webservice" ] } }, "/api/camera/generateWifiChangeAuthorizationToken" : { "post" : { "description" : "Create a change wifi request for QR code generation", "operationId" : "generateWifiChangeAuthorizationToken", "parameters" : [ { "in" : "header", "name" : "RHOMBUS_MY_IP", "schema" : { "type" : "string", "default" : "", "nullable" : true } }, { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GenerateWifiChangeAuthorizationTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GenerateWifiChangeAuthorizationTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate WiFi change authorization token", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getBatchRegistrationUsage" : { "post" : { "description" : "Get detailed usage information for a registration token", "operationId" : "getBatchRegistrationUsage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetBatchRegistrationTokenUsageRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetBatchRegistrationTokenUsageResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get batch registration usage", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getCameraAIThresholds" : { "post" : { "description" : "Get AI normalized confidence thresholds for a camera", "operationId" : "getCameraAIThresholds", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCameraAIThresholdsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCameraAIThresholdsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera AI thresholds", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getCloudArchivedMediaInfo" : { "post" : { "description" : "Get information on archived video for specified camera", "operationId" : "getCloudArchivedMediaInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCloudArchivedMediaInfoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCloudArchivedMediaInfoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get cloud archived media info", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getCloudArchivingConfig" : { "post" : { "description" : "Get the cloud archiving scheduling config applicable to a camera", "operationId" : "getCloudArchivingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCloudArchivingConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCloudArchivingConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get cloud archiving config", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getConfig" : { "post" : { "deprecated" : true, "description" : "Get a camera's config", "operationId" : "getCameraConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera config", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getCurrentState" : { "post" : { "deprecated" : true, "description" : "Use /getFullCameraState instead", "operationId" : "getCurrentCameraState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCurrentStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCurrentStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get current camera state", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getCustomFootageSeekpointsV2" : { "post" : { "description" : "Get activity seekpoints for specified camera", "operationId" : "getCustomFootageSeekpointsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCustomFootageSeekpointsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCustomFootageSeekpointsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get custom footage seekpoints V2", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getDetails" : { "post" : { "description" : "Get hardware details of multiple cameras", "operationId" : "getCameraDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCameraDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetCameraDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera details", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getFootageBoundingBoxes" : { "post" : { "description" : "Get object bounding boxes for a specified camera. Note: bounding box values are given as permyriad shorts relative to image. To convert to absolute pixel values, use the following: abs_pix = (rel_permyriad / 10000) * image_dim", "operationId" : "getCameraFootageBoundingBoxes", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageBoundingBoxesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageBoundingBoxesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get footage bounding boxes", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getFootageBoundingBoxesForMultiple" : { "post" : { "description" : "Get object bounding boxes for multiple cameras. Note: bounding box values are given as permyriad shorts relative to image. To convert to absolute pixel values, use the following: abs_pix = (rel_permyriad / 10000) * image_dim", "operationId" : "getFootageBoundingBoxesForMultiple", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageBoundingBoxesForMultipleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageBoundingBoxesForMultipleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get footage bounding boxes for multiple cameras", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getFootageSeekpointsForMultiple" : { "post" : { "description" : "Get activity seekpoints for multiple cameras", "operationId" : "getFootageSeekpointsForMultiple", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageSeekpointsForMultipleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageSeekpointsForMultipleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get footage seekpoints for multiple cameras", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getFootageSeekpointsV2" : { "post" : { "description" : "Get activity seekpoints for specified camera", "operationId" : "getCameraFootageSeekpointsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageSeekpointsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFootageSeekpointsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get footage seekpoints V2", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getFullCameraState" : { "post" : { "description" : "Get detailed information about state of specified camera", "operationId" : "getFullCameraState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFullCameraStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetFullCameraStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get full camera state", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getMediaUris" : { "post" : { "description" : "Get media uris for camera to retrieve footage", "operationId" : "getCameraMediaUris", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMediaUrisWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMediaUrisWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera media URIs", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getMinimalCameraLocationMap" : { "post" : { "description" : "Get basic information about all cameras and their locations in organization", "operationId" : "getMinimalCameraLocationMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalCameraLocationMapWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalCameraLocationMapWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal camera location map", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getMinimalCameraStateList" : { "post" : { "description" : "Get basic state information about all cameras in organization", "operationId" : "getMinimalCameraStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalCameraStateListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalCameraStateListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal camera state list", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getMinimalList" : { "post" : { "deprecated" : true, "description" : "Use /getMinimalCameraStateList instead", "operationId" : "getCameraMinimalList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetMinimalListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal camera list", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getOfflineLanStreamingInfo" : { "post" : { "description" : "Get required information for offline lan streaming on all cameras", "operationId" : "getCameraOfflineLanStreamingInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetOfflineLanStreamingInfoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetOfflineLanStreamingInfoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera offline LAN streaming info", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getPresenceWindows" : { "post" : { "description" : "Get stored video information for camera", "operationId" : "getCameraPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera presence windows", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getRawHttpStreams" : { "post" : { "description" : "Get info for all raw HTTP streams from a camera", "operationId" : "getCameraRawHttpStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera raw HTTP streams", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getStorageRecoveryFile" : { "post" : { "description" : "Get a file that contains information required to recover the media from the SD card of a damaged camera", "operationId" : "getStorageRecoveryFile", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetStorageRecoveryFileWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetStorageRecoveryFileWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get storage recovery file", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getUptimeWindows" : { "post" : { "description" : "Get uptime information for camera", "operationId" : "getUptimeWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetUptimeWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetUptimeWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera uptime windows", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getUptimeWindowsForOrg" : { "post" : { "description" : "Get uptime windows for all (or selected) cameras in the organization in a single call", "operationId" : "getUptimeWindowsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera uptime windows in batch", "tags" : [ "Camera Webservice" ] } }, "/api/camera/getVideoWalls" : { "post" : { "description" : "Get list of video walls available for client", "operationId" : "getVideoWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetVideoWallsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_GetVideoWallsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get video walls", "tags" : [ "Camera Webservice" ] } }, "/api/camera/ptzMove" : { "post" : { "description" : "Move a first-party mechanical PTZ camera by permyriad delta", "operationId" : "ptzMoveCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CameraPTZMoveWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_CameraPTZMoveWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "PTZ move", "tags" : [ "Camera Webservice" ] } }, "/api/camera/reboot" : { "post" : { "description" : "Send reboot command to camera", "operationId" : "rebootCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RebootCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RebootCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reboot camera", "tags" : [ "Camera Webservice" ] } }, "/api/camera/revertCameraSettingsToDefaults" : { "post" : { "operationId" : "revertCameraSettingsToDefaults", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSRequest" } } } }, "responses" : { "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSResponse" } } }, "description" : "default response" } }, "tags" : [ "Camera Webservice" ] } }, "/api/camera/revertDayImageSettingsToDefaults" : { "post" : { "operationId" : "revertDayImageSettingsToDefaults", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSRequest" } } } }, "responses" : { "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSResponse" } } }, "description" : "default response" } }, "tags" : [ "Camera Webservice" ] } }, "/api/camera/revertNightImageSettingsToDefaults" : { "post" : { "operationId" : "revertNightImageSettingsToDefaults", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSRequest" } } } }, "responses" : { "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSResponse" } } }, "description" : "default response" } }, "tags" : [ "Camera Webservice" ] } }, "/api/camera/revertToDefaults" : { "post" : { "operationId" : "revertToDefaults", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSRequest" } } } }, "responses" : { "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_RevertCameraToDefaultsWSResponse" } } }, "description" : "default response" } }, "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateCameraAIThresholds" : { "post" : { "description" : "Update AI confidence thresholds for a camera", "operationId" : "updateCameraAIThresholds", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraAIThresholdsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraAIThresholdsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera AI thresholds", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateCameraLineCrossingThresholds" : { "post" : { "description" : "Updates the line-crossing feature for a camera. Accepts two points which define a line that determines the threshold for which INGRESS and EGRESS events will be generated. Consider the top-left corner of a camera's image to be the origin (0,0).", "operationId" : "updateCameraLineCrossingThresholds", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera line crossing thresholds", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateConfig" : { "post" : { "deprecated" : true, "description" : "Update a camera's config", "operationId" : "updateCameraConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera config", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateDetails" : { "post" : { "deprecated" : true, "description" : "Update hardware details of camera", "operationId" : "updateCameraDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera details", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateDetailsBulkV2" : { "post" : { "description" : "Update hardware details of multiple cameras in bulk", "operationId" : "updateDetailsBulkV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCamerasBulkV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera details bulk V2", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateDetailsV2" : { "post" : { "description" : "Update hardware details of camera.", "operationId" : "updateCameraDetailsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera details V2", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateFirmware" : { "post" : { "description" : "Send command to update firmware to camera", "operationId" : "updateFirmware", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraFirmwareWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateCameraFirmwareWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera firmware", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateVideoWalls" : { "post" : { "description" : "Update a video wall", "operationId" : "updateVideoWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateVideoWallWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateVideoWallWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update video walls", "tags" : [ "Camera Webservice" ] } }, "/api/camera/updateWifi" : { "post" : { "description" : "Send a command to update wifi on specified connected cameras", "operationId" : "updateCameraWifi", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateWifiWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Camera_UpdateWifiWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera WiFi", "tags" : [ "Camera Webservice" ] } }, "/api/climate/deleteEnvironmentalGateway" : { "post" : { "description" : "Remove an environmental gateway from the org", "operationId" : "deleteEnvironmentalGateway", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_DeleteEnvironmentalGatewayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_DeleteEnvironmentalGatewayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete environmental gateway", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getClimateEventsForSensor" : { "post" : { "description" : "Get list of climate events for environmental sensor", "operationId" : "getClimateEventsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetClimateEventsForSensorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetClimateEventsForSensorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get climate events for environmental sensor", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getClimatePresenceWindows" : { "post" : { "description" : "Get stored video information for sensor", "operationId" : "getClimatePresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get climate presence windows", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getConfig" : { "post" : { "description" : "Get the config for a climate sensor", "operationId" : "getConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetClimateSensorConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetClimateSensorConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get climate sensor config", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getEnvironmentalGatewayShadows" : { "post" : { "description" : "Get list of shadows of all environmental gateways of an org", "operationId" : "getEnvironmentalGatewayShadows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetEnvironmentalGatewayShadowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetEnvironmentalGatewayShadowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get environmental gateway shadows", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getEventsForEnvironmentalGateway" : { "post" : { "description" : "Get list of events for environmental gateway", "operationId" : "getEventsForEnvironmentalGateway", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get events for environmental gateway", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getMinimalClimateStateList" : { "post" : { "description" : "Get basic state information of all environmental sensors", "operationId" : "getMinimalClimateStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetMinimalClimateStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetMinimalClimateStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal climate state list", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getMinimalEnvironmentalGatewayStates" : { "post" : { "description" : "Get list of basic states of all environmental gateways of an org", "operationId" : "getMinimalEnvironmentalGatewayStates", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal environmental gateway states", "tags" : [ "Climate Webservice" ] } }, "/api/climate/getMinimalStateEventsForEnvironmentalGateway" : { "post" : { "description" : "Get list of events for environmental gateways in minimal state", "operationId" : "getMinimalStateEventsForEnvironmentalGateway", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_GetMinimalEnvironmentalGatewayStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal state events for environmental gateway", "tags" : [ "Climate Webservice" ] } }, "/api/climate/reboot" : { "post" : { "description" : "Send reboot command to environmental gateway", "operationId" : "rebootEnvironmentalGateway", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_RebootEnvironmentalGatewayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reboot environmental gateway", "tags" : [ "Climate Webservice" ] } }, "/api/climate/updateDetails" : { "post" : { "description" : "Update details for environmental sensor. Note: uuid is a required field", "operationId" : "updateClimateSensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_UpdateClimateSensorDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_UpdateClimateSensorDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update climate sensor details", "tags" : [ "Climate Webservice" ] } }, "/api/climate/updateEnvironmentalGatewayDetails" : { "post" : { "description" : "Update details for environmental gateway. Note: uuid is a required field", "operationId" : "updateEnvironmentalGatewayDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_UpdateEnvironmentalGatewayDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Climate_UpdateEnvironmentalGatewayDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update environmental gateway details", "tags" : [ "Climate Webservice" ] } }, "/api/component/addAccessControlledDoorLabel" : { "post" : { "description" : "Create a label that can be assigned to an access controlled door and referenced by an access grant or access revocation", "operationId" : "addAccessControlledDoorLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_AddAccessControlledDoorLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_AddAccessControlledDoorLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a label that can be assigned to an access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/createAccessControlledDoor" : { "post" : { "description" : "Create an access controlled door", "operationId" : "createAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create an access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/createAccessControlledDoorSeekpoints" : { "post" : { "description" : "Create custom activity seekpoints for a specified access controlled door", "operationId" : "createAccessControlledDoorSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateAccessControlledDoorSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateAccessControlledDoorSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create custom activity seekpoints for a specified access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedDoorPositionIndicator" : { "post" : { "description" : "Create a door position indicator component", "operationId" : "createIntegratedDoorPositionIndicator", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedDoorPositionIndicatorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedDoorPositionIndicatorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a door position indicator component", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedDoorRelay" : { "post" : { "description" : "Create a door relay component", "operationId" : "createIntegratedDoorRelay", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedDoorRelayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedDoorRelayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a door relay component", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedGenericButton" : { "post" : { "description" : "Create a generic button component", "operationId" : "createIntegratedGenericButton", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericButtonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericButtonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a generic button component", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedGenericInput" : { "post" : { "description" : "Create a generic input component", "operationId" : "createIntegratedGenericInput", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericInputWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericInputWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a generic input component", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedGenericRelay" : { "post" : { "description" : "Create a generic relay component", "operationId" : "createIntegratedGenericRelay", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericRelayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedGenericRelayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a generic relay component", "tags" : [ "Component Webservice" ] } }, "/api/component/createIntegratedRequestToExit" : { "post" : { "description" : "Create a request to exit component", "operationId" : "createIntegratedRequestToExit", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedRequestToExitWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateIntegratedRequestToExitWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a request to exit component", "tags" : [ "Component Webservice" ] } }, "/api/component/createOsdpDoorReader" : { "post" : { "description" : "Create a third party OSDP Reader component", "operationId" : "createOsdpDoorReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateOsdpReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateOsdpReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a third party OSDP Reader component", "tags" : [ "Component Webservice" ] } }, "/api/component/createRhombusOsdpDoorReader" : { "post" : { "description" : "Create a Rhombus OSDP Reader component", "operationId" : "createRhombusOsdpDoorReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateRhombusOsdpReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateRhombusOsdpReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a Rhombus OSDP Reader component", "tags" : [ "Component Webservice" ] } }, "/api/component/createWiegandReader" : { "post" : { "description" : "Create a third party Wiegand Reader component", "operationId" : "createWiegandReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateWiegandReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_CreateWiegandReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a third party Wiegand Reader component", "tags" : [ "Component Webservice" ] } }, "/api/component/deleteAccessControlledDoor" : { "post" : { "description" : "Delete the specified access controlled door", "operationId" : "deleteAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete the specified access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/deleteComponent" : { "post" : { "description" : "Delete a component", "operationId" : "deleteComponent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteComponentWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteComponentWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a component", "tags" : [ "Component Webservice" ] } }, "/api/component/deleteComponentsByOwnerDevice" : { "post" : { "description" : "Delete all components owned by the specified device", "operationId" : "deleteComponentsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteComponentsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_DeleteComponentsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete all components owned by the specified device", "tags" : [ "Component Webservice" ] } }, "/api/component/elevator/addAccessControlledElevatorLandingLabel" : { "post" : { "description" : "Create a label that can be assigned to an access controlled elevator landing and referenced by an access grant or access revocation", "operationId" : "addAccessControlledElevatorLandingLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_AddAccessControlledElevatorLandingLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_AddAccessControlledElevatorLandingLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a label that can be assigned to an access controlled elevator landing", "tags" : [ "Elevator Webservice" ] } }, "/api/component/elevator/findAccessControlledElevatorLandingShadows" : { "post" : { "description" : "Find access controlled elevator landing shadows within the org", "operationId" : "findAccessControlledElevatorLandingShadows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingShadowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingShadowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled elevator landing shadows within the org", "tags" : [ "Elevator Webservice" ] } }, "/api/component/elevator/findAccessControlledElevatorLandingShadowsByLocation" : { "post" : { "description" : "Find access controlled elevator landing shadows within the specified location", "operationId" : "findAccessControlledElevatorLandingShadowsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingShadowsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingShadowsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled elevator landing shadows within the specified location", "tags" : [ "Elevator Webservice" ] } }, "/api/component/elevator/findAccessControlledElevatorLandingsByLocation" : { "post" : { "description" : "Find access controlled elevators landings within the specified location", "operationId" : "findAccessControlledElevatorLandingsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledElevatorLandingsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled elevators landings within the specified location", "tags" : [ "Elevator Webservice" ] } }, "/api/component/elevator/getAccessControlledElevatorLandingLabelsForOrg" : { "post" : { "description" : "Get all access controlled elevator landing labels for the organization", "operationId" : "getAccessControlledElevatorLandingLabelsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetAccessControlledElevatorLandingLabelsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetAccessControlledElevatorLandingLabelsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get all access controlled elevator landing labels for the organization", "tags" : [ "Elevator Webservice" ] } }, "/api/component/elevator/removeAccessControlledElevatorLandingLabel" : { "post" : { "description" : "Remove a label to an access controlled elevator landing", "operationId" : "removeAccessControlledElevatorLandingLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_RemoveAccessControlledElevatorLandingLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_RemoveAccessControlledElevatorLandingLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove a label to an access controlled elevator landing", "tags" : [ "Elevator Webservice" ] } }, "/api/component/findAccessControlledDoorShadows" : { "post" : { "description" : "Find access controlled door shadows within the org", "operationId" : "findAccessControlledDoorShadows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorShadowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorShadowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled door shadows within the org", "tags" : [ "Component Webservice" ] } }, "/api/component/findAccessControlledDoorShadowsByLocation" : { "post" : { "description" : "Find access controlled door shadows within the specified location", "operationId" : "findAccessControlledDoorShadowsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorShadowsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorShadowsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled door shadows within the specified location", "tags" : [ "Component Webservice" ] } }, "/api/component/findAccessControlledDoors" : { "post" : { "description" : "Find access controlled doors within the org", "operationId" : "findAccessControlledDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled doors within the org", "tags" : [ "Component Webservice" ] } }, "/api/component/findAccessControlledDoorsByLocation" : { "post" : { "description" : "Find access controlled doors within the specified location", "operationId" : "findAccessControlledDoorsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled doors within the specified location", "tags" : [ "Component Webservice" ] } }, "/api/component/findAccessControlledDoorsByOwnerDevice" : { "post" : { "description" : "Find access controlled doors for the specified owner device", "operationId" : "findAccessControlledDoorsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAccessControlledDoorsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find access controlled doors for the specified owner device", "tags" : [ "Component Webservice" ] } }, "/api/component/findAllComponentShadows" : { "post" : { "description" : "Retrieve all component shadows for the specified component uuids", "operationId" : "findAllComponentShadows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAllComponentShadowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindAllComponentShadowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component shadows for the specified component uuids", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByAccessControlledDoor" : { "post" : { "description" : "Retrieve all component events relevant to the specified AccessControlledDoor", "operationId" : "findComponentEventsByAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified AccessControlledDoor", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByApiToken" : { "post" : { "description" : "Retrieve all component events relevant to the specified api token", "operationId" : "findComponentEventsByApiToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByApiTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByApiTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified api token", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByComponent" : { "post" : { "description" : "Retrieve all component events relevant to the specified component", "operationId" : "findComponentEventsByComponent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByComponentWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByComponentWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified component", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByCorrelation" : { "post" : { "description" : "Retrieve all component events relevant to the specified correlation id", "operationId" : "findComponentEventsByCorrelation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCorrelationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCorrelationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified correlation id", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByCredentialHexValue" : { "post" : { "description" : "Retrieve all component events relevant to the specified credential hex value", "operationId" : "findComponentEventsByCredentialHexValue", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialHexValueWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialHexValueWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified credential hex value", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByCredentialUuid" : { "post" : { "description" : "Retrieve all component events relevant to the specified credential uuid", "operationId" : "findComponentEventsByCredentialUuid", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialUuidWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialUuidWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified credential uuid", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByCredentialValue" : { "post" : { "description" : "Retrieve all component events relevant to the specified credential value", "operationId" : "findComponentEventsByCredentialValue", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialValueWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByCredentialValueWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified credential value", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByGuestPass" : { "post" : { "description" : "Retrieve all component events relevant to the specified guest pass", "operationId" : "findComponentEventsByGuestPass", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByGuestPassWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByGuestPassWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified guest pass", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByLocation" : { "post" : { "description" : "Retrieve all component events relevant to the specified location", "operationId" : "findComponentEventsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified location", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByOwnerDevice" : { "post" : { "deprecated" : true, "description" : "Retrieve all component events relevant to the specified owner device (i.e. DC20's device uuid)", "operationId" : "findComponentEventsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified owner device (deprecated)", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsBySupportAuthority" : { "post" : { "description" : "Retrieve all component events relevant to the specified api token", "operationId" : "findComponentEventsBySupportAuthority", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsBySupportAuthorityWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsBySupportAuthorityWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified support authority", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsByUser" : { "post" : { "description" : "Retrieve all component events relevant to the specified User", "operationId" : "findComponentEventsByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified User", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentEventsForVideoIntercom" : { "post" : { "description" : "Retrieve all component events relevant to the specified Video Intercom and optional AccessControlledDoor", "operationId" : "findComponentEventsForVideoIntercom", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsForVideoIntercomWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentEventsForVideoIntercomWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified Video Intercom and optional AccessControlledDoor", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByAccessControlledDoor" : { "post" : { "description" : "Find component seekpoints by access controlled door", "operationId" : "findComponentSeekPointsByAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByAccessControlledDoors" : { "post" : { "description" : "Find component seekpoints by access controlled doors", "operationId" : "findComponentSeekPointsByAccessControlledDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by access controlled doors", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByComponent" : { "post" : { "description" : "Find component seekpoints by component", "operationId" : "findComponentSeekPointsByComponent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByComponentWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByComponentWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by component", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByLocation" : { "post" : { "description" : "Find component seekpoints by location", "operationId" : "findComponentSeekPointsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by location", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByOwnerDevice" : { "post" : { "description" : "Find component seekpoints by owner device", "operationId" : "findComponentSeekPointsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by owner device", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentSeekPointsByUser" : { "post" : { "description" : "Find component seekpoints by user", "operationId" : "findComponentSeekPointsByUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find component seekpoints by user", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentShadowsByComponentComposites" : { "post" : { "description" : "Retrieve all component shadows for the components belonging to the specified component composites (doors, elevators, elevator landings). Each composite is expanded to its component references and the resulting set of component shadows is returned.", "operationId" : "findComponentShadowsByComponentComposites", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentShadowsByComponentCompositesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentShadowsByComponentCompositesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component shadows for the components belonging to the specified component composites", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentShadowsByOwnerDevice" : { "post" : { "description" : "Retrieve component shadows by the specified owner device uuid", "operationId" : "findComponentShadowsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentShadowsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentShadowsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve component shadows by the specified owner device uuid", "tags" : [ "Component Webservice" ] } }, "/api/component/findComponentsByOwnerDevice" : { "post" : { "description" : "Retrieve a list of components owned by a Rhombus device (i.e. DC20's device uuid)", "operationId" : "findComponentsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindComponentsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve a list of components owned by a Rhombus device", "tags" : [ "Component Webservice" ] } }, "/api/component/findMinimalStateAccessControlledDoors" : { "post" : { "description" : "Find minimal state access controlled doors within the org", "operationId" : "findMinimalStateAccessControlledDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindMinimalStateAccessControlledDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindMinimalStateAccessControlledDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find minimal state access controlled doors within the org", "tags" : [ "Component Webservice" ] } }, "/api/component/findMinimalStateAccessControlledDoorsByLocation" : { "post" : { "description" : "Find minimal state access controlled doors within the specified location", "operationId" : "findMinimalStateAccessControlledDoorsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindMinimalStateAccessControlledDoorsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindMinimalStateAccessControlledDoorsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find minimal state access controlled doors within the specified location", "tags" : [ "Component Webservice" ] } }, "/api/component/findPaginatedComponentEventsByAccessControlledDoor" : { "post" : { "description" : "Retrieve all component events relevant to the specified AccessControlledDoor", "operationId" : "findPaginatedComponentEventsByAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified AccessControlledDoor", "tags" : [ "Component Webservice" ] } }, "/api/component/findPaginatedComponentEventsByOwnerDevice" : { "post" : { "description" : "Retrieve all component events relevant to the specified owner device (i.e. DC20's device uuid)", "operationId" : "findPaginatedComponentEventsByOwnerDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByOwnerDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByOwnerDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified owner device", "tags" : [ "Component Webservice" ] } }, "/api/component/getAccessControlledDoorLabelsForOrg" : { "post" : { "description" : "Get all access controlled door labels for the organization", "operationId" : "getAccessControlledDoorLabelsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetAccessControlledDoorLabelsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetAccessControlledDoorLabelsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get all access controlled door labels for the organization", "tags" : [ "Component Webservice" ] } }, "/api/component/getOrCreateDevicePhysicalPortConfig" : { "post" : { "description" : "Gets a physical port layout for the specified device, components owned by that device and details about the port configuration validity. Map is instantiated if it doesn't currently exist as part of the call.", "operationId" : "getOrCreateDevicePhysicalPortConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetOrCreateDevicePhysicalPortConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_GetOrCreateDevicePhysicalPortConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get or create device physical port config", "tags" : [ "Component Webservice" ] } }, "/api/component/removeAccessControlledDoorLabel" : { "post" : { "description" : "Remove a label to an access controlled door", "operationId" : "removeAccessControlledDoorLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_RemoveAccessControlledDoorLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_RemoveAccessControlledDoorLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove a label to an access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/updateAccessControlledDoor" : { "post" : { "description" : "Updates an access controlled door", "operationId" : "updateAccessControlledDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateAccessControlledDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateAccessControlledDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Updates an access controlled door", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedDoorPositionIndicator" : { "post" : { "description" : "Update a door position indicator component", "operationId" : "updateIntegratedDoorPositionIndicator", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedDoorPositionIndicatorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedDoorPositionIndicatorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a door position indicator component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedDoorRelay" : { "post" : { "description" : "Update a door relay component", "operationId" : "updateIntegratedDoorRelay", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedDoorRelayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedDoorRelayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a door relay component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedGenericButton" : { "post" : { "description" : "Update a generic button component", "operationId" : "updateIntegratedGenericButton", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericButtonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericButtonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a generic button component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedGenericInput" : { "post" : { "description" : "Update a generic input component", "operationId" : "updateIntegratedGenericInput", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericInputWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericInputWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a generic input component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedGenericRelay" : { "post" : { "description" : "Update a generic relay component", "operationId" : "updateIntegratedGenericRelay", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelayWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelayWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a generic relay component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedGenericRelaySteadyState" : { "post" : { "description" : "Update a generic relay component's steady state", "operationId" : "updateIntegratedGenericRelaySteadyState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelaySteadyStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelaySteadyStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a generic relay component's steady state", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedGenericRelayTransientState" : { "post" : { "description" : "Activate a generic relay for a brief period", "operationId" : "updateIntegratedGenericRelayTransientState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelayTransientStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedGenericRelayTransientStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Activate a generic relay for a brief period", "tags" : [ "Component Webservice" ] } }, "/api/component/updateIntegratedRequestToExit" : { "post" : { "description" : "Update a request to exit component", "operationId" : "updateIntegratedRequestToExit", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedRequestToExitWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateIntegratedRequestToExitWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a request to exit component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateOsdpDoorReader" : { "post" : { "description" : "Update a third party OSDP Reader component", "operationId" : "updateOsdpDoorReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateOsdpReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateOsdpReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a third party OSDP Reader component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateRhombusOsdpDoorReader" : { "post" : { "description" : "Update a Rhombus OSDP Reader component", "operationId" : "updateRhombusOsdpDoorReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateRhombusOsdpReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateRhombusOsdpReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a Rhombus OSDP Reader component", "tags" : [ "Component Webservice" ] } }, "/api/component/updateWiegandDoorReader" : { "post" : { "description" : "Update a third party Wiegand Reader component", "operationId" : "updateWiegandDoorReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateWiegandReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component_UpdateWiegandReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a third party Wiegand Reader component", "tags" : [ "Component Webservice" ] } }, "/api/customer/deleteAllNotificationSnoozeSettings" : { "post" : { "description" : "Delete a policy pause setting for a device", "operationId" : "deleteAllNotificationSnoozeSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete all notification snooze settings", "tags" : [ "Customer Webservice" ] } }, "/api/customer/deleteNotificationSnoozeSettingForComponentComposite" : { "post" : { "description" : "Delete a policy pause setting for a component composite", "operationId" : "deleteNotificationSnoozeSettingForComponentComposite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a policy pause setting for a component composite", "tags" : [ "Customer Webservice" ] } }, "/api/customer/deleteNotificationSnoozeSettingForDevice" : { "post" : { "description" : "Delete a policy pause setting for a device", "operationId" : "deleteNotificationSnoozeSettingForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a policy pause setting for a device", "tags" : [ "Customer Webservice" ] } }, "/api/customer/deleteNotificationSnoozeSettingForLocation" : { "post" : { "description" : "Delete a policy pause setting for a location", "operationId" : "deleteNotificationSnoozeSettingForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_DeleteNotificationSnoozeSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a policy pause setting for a location", "tags" : [ "Customer Webservice" ] } }, "/api/customer/getUserSnoozedNotificationSettings" : { "post" : { "description" : "Get the current and planned user notification snooze details", "operationId" : "getUserSnoozedNotificationSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_GetUserSnoozedNotificationSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer_GetUserSnoozedNotificationSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get the current and planned user notification snooze details", "tags" : [ "Customer Webservice" ] } }, "/api/customer/updateCurrentUserNotificationSettings" : { "post" : { "description" : "Update notification settings for user", "operationId" : "updateCurrentUserNotificationSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update notification settings for user", "tags" : [ "User Webservice", "Customer Webservice" ] } }, "/api/developer/createEventListener" : { "post" : { "description" : "Create an event listener", "operationId" : "createEventListener", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_CreateEventListenerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_CreateEventListenerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create an event listener", "tags" : [ "Developer Webservice" ] } }, "/api/developer/deleteEventListener" : { "post" : { "description" : "Delete an event listener", "operationId" : "deleteEventListener", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_DeleteEventListenerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_DeleteEventListenerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete an event listener", "tags" : [ "Developer Webservice" ] } }, "/api/developer/getAllEventListeners" : { "post" : { "description" : "Get a list of all event listeners", "operationId" : "getAllEventListeners", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_GetAllEventListenersWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_GetAllEventListenersWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a list of all event listeners", "tags" : [ "Developer Webservice" ] } }, "/api/developer/getEventListenersForDevice" : { "post" : { "description" : "Get a list of event listeners for a device", "operationId" : "getEventListenersForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_GetEventListenersForDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Developer_GetEventListenersForDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a list of event listeners for a device", "tags" : [ "Developer Webservice" ] } }, "/api/deviceconfig/getFacetedConfig" : { "post" : { "description" : "Get a device's config", "operationId" : "getFacetedConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Device_config_GetConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Device_config_GetFacetedUserConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a device's config", "tags" : [ "Device Config Webservice" ] } }, "/api/deviceconfig/updateFacetedConfig" : { "post" : { "description" : "Update a device's config", "operationId" : "updateFacetedConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Device_config_UpdateFacetedUserConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a device's config", "tags" : [ "Device Config Webservice" ] } }, "/api/door/getDoorEventsForSensor" : { "post" : { "description" : "Get list of door open/close events for door sensor", "operationId" : "getDoorEventsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_GetDoorEventsForSensorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_GetDoorEventsForSensorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of door open/close events for door sensor", "tags" : [ "Door Webservice" ] } }, "/api/door/getDoorPresenceWindows" : { "post" : { "description" : "Get stored video information for sensor", "operationId" : "getDoorPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get stored video information for sensor", "tags" : [ "Door Webservice" ] } }, "/api/door/getMinimalDoorStateList" : { "post" : { "description" : "Get basic state information for all door sensors", "operationId" : "getMinimalDoorStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_GetMinimalDoorStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_GetMinimalDoorStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get basic state information for all door sensors", "tags" : [ "Door Webservice" ] } }, "/api/door/updateDetails" : { "post" : { "description" : "Update details for door sensor. Note: uuid is a required field", "operationId" : "updateDoorSensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_UpdateDoorSensorDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Door_UpdateDoorSensorDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update details for door sensor", "tags" : [ "Door Webservice" ] } }, "/api/doorbellcamera/calibrateFloorplanProjection" : { "post" : { "description" : "Generate the homography to project detections onto a floorplan.", "operationId" : "doorbellCameraCalibrateFloorplanProjection", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate the homography to project detections onto a floorplan", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/createRawHttpStream" : { "post" : { "description" : "Create a raw HTTP stream for a doorbell camera.", "operationId" : "createDoorbellCameraRawHttpStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a raw HTTP stream for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/createRuleForDoorbellCamera" : { "post" : { "description" : "Create rule for a doorbell camera.", "operationId" : "createRuleForDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create rule for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/createSharedLiveVideoStream" : { "post" : { "description" : "Share an live video stream for a doorbell camera", "operationId" : "createDoorbellCameraSharedLiveVideoStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Share an live video stream for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/delete" : { "post" : { "description" : "Remove the doorbell camera from the organization", "operationId" : "deleteDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove the doorbell camera from the organization", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/deleteRawHttpStream" : { "post" : { "description" : "Delete a raw HTTP stream for a doorbell camera.", "operationId" : "deleteDoorbellCameraRawHttpStream", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a raw HTTP stream for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/deleteRuleForDoorbellCamera" : { "post" : { "description" : "Delete rule for a doorbell camera.", "operationId" : "deleteRuleForDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rule for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/findAllRawHttpStreams" : { "post" : { "description" : "Get a list of all doorbell cameras raw HTTP streams.", "operationId" : "findAllDoorbellCameraRawHttpStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a list of all doorbell cameras raw HTTP streams", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/findComponentEventsForDoorbellCamera" : { "post" : { "description" : "Retrieve all component events relevant to the specified Doorbell Camera", "operationId" : "findComponentEventsForDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component events relevant to the specified Doorbell Camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/findComponentSeekPointsForDoorbellCamera" : { "post" : { "description" : "Retrieve all component seekpoints relevant to the specified Doorbell Camera", "operationId" : "findComponentSeekPointsForDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retrieve all component seekpoints relevant to the specified Doorbell Camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/findSharedLiveVideoStreams" : { "post" : { "description" : "Get list of all shared live streams for doorbell camera", "operationId" : "findDoorbellCameraSharedLiveVideoStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of all shared live streams for doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getBoundingBoxes" : { "post" : { "description" : "Get object bounding boxes for a specified doorbell camera. Note: bounding box values are given as permyriad shorts relative to image. To convert to absolute pixel values, use the following: abs_pix = (rel_permyriad / 10000) * image_dim", "operationId" : "getDoorbellCameraBoundingBoxes", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetBoundingBoxesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetBoundingBoxesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get object bounding boxes for a specified doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getConfig" : { "post" : { "description" : "Get a doorbell camera's config", "operationId" : "getDoorbellCameraConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Device_config_GetConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a doorbell camera's config", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getDoorbellCameraRulesForOrg" : { "post" : { "description" : "Get rules for all doorbell cameras in an org.", "operationId" : "getDoorbellCameraRulesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rules for all doorbell cameras in an org", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getFullState" : { "post" : { "description" : "Get detailed information about state of specified doorbell camera", "operationId" : "getDoorbellCameraFullState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetFullDeviceStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraFullStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get detailed information about state of specified doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getMediaUris" : { "post" : { "description" : "Get media uris for doorbell camera to retrieve footage and audio", "operationId" : "getDoorbellCameraMediaUris", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetMediaUrisWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraMediaUrisWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get media uris for doorbell camera to retrieve footage and audio", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getMinimalStateList" : { "post" : { "description" : "Get basic state information about all doorbell cameras in organization", "operationId" : "getDoorbellCameraMinimalStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetMinimalDeviceStateListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraMinimalStateListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get basic state information about all doorbell cameras in organization", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getOfflineLanStreamingInfo" : { "post" : { "description" : "Get required information for offline lan streaming on all video intercoms", "operationId" : "getDoorbellCameraOfflineLanStreamingInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get required information for offline lan streaming on all video intercoms", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getPresenceWindows" : { "post" : { "description" : "Get stored video information for a doorbell camera", "operationId" : "getDoorbellCameraPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get stored video information for a doorbell camera", "tags" : [ "Doorbell Webservice", "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getRawHttpStreams" : { "post" : { "description" : "Get info for all raw HTTP streams from a doorbell camera.", "operationId" : "getDoorbellCameraRawHttpStreams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get info for all raw HTTP streams from a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getRulesForDoorbellCamera" : { "post" : { "description" : "Get all rules for a doorbell camera.", "operationId" : "getRulesForDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get all rules for a doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getSeekpoints" : { "post" : { "description" : "Get activity seekpoints for specified doorbell camera", "operationId" : "getDoorbellCameraSeekPoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get activity seekpoints for specified doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/getUptimeWindows" : { "post" : { "description" : "Get uptime information for a doorbell camera", "operationId" : "getDoorbellCameraUptimeWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get uptime information for a doorbell camera", "tags" : [ "Doorbell Webservice", "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/reboot" : { "post" : { "description" : "Reboot the specified doorbell camera", "operationId" : "rebootDoorbellCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_RebootDoorbellCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reboot the specified doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/reportTalkSession" : { "post" : { "description" : "Report that the calling operator started or ended talking through a video intercom. Emits an IntercomTalkEvent component event correlatable with the intercom's DoorbellEvent button presses; the STARTED and ENDED reports of one hold share a talkSessionUuid.", "operationId" : "reportDoorbellCameraTalkSession", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_ReportTalkSessionWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_ReportTalkSessionWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Report an operator talk session on a video intercom", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/updateConfig" : { "post" : { "description" : "Update a doorbell camera's config", "operationId" : "updateDoorbellCameraConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_UpdateDoorbellCameraConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update a doorbell camera's config", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorbellcamera/updateDetails" : { "post" : { "description" : "Update hardware details of doorbell camera.", "operationId" : "updateDoorbellCameraDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorbellcamera_UpdateDoorbellCameraDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateDeviceDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update hardware details of doorbell camera", "tags" : [ "Doorbell Camera Webservice" ] } }, "/api/doorcontroller/registerDiscoveredRhombusReader" : { "post" : { "description" : "Register a Rhombus reader that a Door Controller has discovered", "operationId" : "registerDiscoveredRhombusReader", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorcontroller_RegisterDiscoveredRhombusReaderWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorcontroller_RegisterDiscoveredRhombusReaderWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Register a Rhombus reader that a Door Controller has discovered", "tags" : [ "Door Controller Webservice" ] } }, "/api/doorcontroller/updateDetails" : { "post" : { "description" : "Update details for door controller. Note: uuid is a required field", "operationId" : "updateDoorControllerDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorcontroller_UpdateDoorControllerDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Doorcontroller_UpdateDoorControllerDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update details for door controller", "tags" : [ "Door Controller Webservice" ] } }, "/api/event/createSharedClipGroupV3" : { "post" : { "description" : "Share multiple clips in a single page", "operationId" : "createSharedClipGroupV3", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_CreateSharedClipGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_CreateSharedClipGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Share multiple clips in a single page", "tags" : [ "Event Webservice" ] } }, "/api/event/deleteAlertMonitoringThreatCase" : { "post" : { "description" : "Delete alert monitoring threat case", "operationId" : "deleteAlertMonitoringThreatCase", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteAlertMonitoringThreatCaseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteAlertMonitoringThreatCaseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete alert monitoring threat case", "tags" : [ "Event Webservice" ] } }, "/api/event/deleteAlertMonitoringThreatCaseByStatus" : { "post" : { "description" : "Delete alert monitoring threat case by status", "operationId" : "deleteAlertMonitoringThreatCaseByStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteAlertMonitoringThreatCaseByStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteAlertMonitoringThreatCaseByStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete alert monitoring threat case by status", "tags" : [ "Event Webservice" ] } }, "/api/event/deleteSavedClip" : { "post" : { "description" : "Delete all types of saved clips (splices in progress, completed splices, saved alerts)", "operationId" : "deleteSavedClip", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteSavedClipWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteSavedClipWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete all types of saved clips (splices in progress, completed splices, saved alerts)", "tags" : [ "Event Webservice" ] } }, "/api/event/deleteSharedClipGroupV2" : { "post" : { "description" : "Delete a shared clip page", "operationId" : "deleteSharedClipGroupV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteSharedClipGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DeleteSharedClipGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete a shared clip page", "tags" : [ "Event Webservice" ] } }, "/api/event/dismissAllPolicyAlertsForDevice" : { "post" : { "description" : "Dismiss all policy alerts for each specified device(s)", "operationId" : "dismissAllPolicyAlertsForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissAllPolicyAlertsForDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissAllPolicyAlertsForDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Dismiss all policy alerts for each specified device(s)", "tags" : [ "Event Webservice" ] } }, "/api/event/dismissAllPolicyAlertsV2" : { "post" : { "description" : "Dismiss all policy alerts in organization", "operationId" : "dismissAllPolicyAlertsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissAllPolicyAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissAllPolicyAlertsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Dismiss all policy alerts in organization", "tags" : [ "Event Webservice" ] } }, "/api/event/dismissPolicyAlertV2" : { "post" : { "description" : "Dismiss a policy alert", "operationId" : "dismissPolicyAlertV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissPolicyAlertWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissPolicyAlertWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Dismiss a policy alert", "tags" : [ "Event Webservice" ] } }, "/api/event/dismissPolicyAlertsV2" : { "post" : { "description" : "Dismiss multiple policy alerts", "operationId" : "dismissPolicyAlertsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissPolicyAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_DismissPolicyAlertsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Dismiss multiple policy alerts", "tags" : [ "Event Webservice" ] } }, "/api/event/getAlertMonitoringThreatCase" : { "post" : { "description" : "Get alert monitoring threat case", "operationId" : "getAlertMonitoringThreatCase", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetAlertMonitoringThreatCaseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetAlertMonitoringThreatCaseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get alert monitoring threat case", "tags" : [ "Event Webservice" ] } }, "/api/event/getAlertMonitoringThreatCases" : { "post" : { "description" : "Get alert monitoring threat cases", "operationId" : "getAlertMonitoringThreatCases", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetAlertMonitoringThreatCasesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetAlertMonitoringThreatCasesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get alert monitoring threat cases", "tags" : [ "Event Webservice" ] } }, "/api/event/getClipWithProgress" : { "post" : { "description" : "Get a specified saved clip with current progress", "operationId" : "getClipWithProgress", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipWithProgressWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipWithProgressWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a specified saved clip with current progress", "tags" : [ "Event Webservice" ] } }, "/api/event/getClipsWithProgress" : { "post" : { "description" : "Get list of saved clips in organization, with current progress", "operationId" : "getClipsWithProgress", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipsWithProgressWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipsWithProgressWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of saved clips in organization, with current progress", "tags" : [ "Event Webservice" ] } }, "/api/event/getExpiringClipsForOrg" : { "post" : { "description" : "Get list of expiring saved clips in organization.", "operationId" : "getExpiringClipsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipsWithProgressWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetClipsWithProgressWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of expiring saved clips in organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getMotionGrid" : { "post" : { "description" : "Get motion data for specified camera", "operationId" : "getMotionGrid", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetMotionGridWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetMotionGridWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get motion data for specified camera", "tags" : [ "Event Webservice" ] } }, "/api/event/getMotionHeatMap" : { "post" : { "description" : "Get aggregated motion heatmap for specified time period and camera. Divides a camera's resolution into a 36x64 grid and counts the number of motion events that occurred in each cell.", "operationId" : "getMotionHeatMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetMotionGridWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetMotionGridCountsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get aggregated motion heatmap for specified time period and camera", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlert" : { "post" : { "description" : "Get information about a policy alert", "operationId" : "getPolicyAlert", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get information about a policy alert", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertCount" : { "post" : { "description" : "Get count of policy alerts", "operationId" : "getPolicyAlertCount", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertCountWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertCountWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get count of policy alerts", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertDetails" : { "post" : { "description" : "Get detailed information about policy alert, including seekpoints and bounding boxes", "operationId" : "getPolicyAlertDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get detailed information about policy alert, including seekpoints and bounding boxes", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertGroupsForDevice" : { "post" : { "description" : "Get recent policy alerts for device, grouped by time. Groups are constructed of alerts that occur within 2 minutes of the previous alert, up to a maximum of 50. Results are returned in reverse-chronological order, so all fields are relative to that ordering.", "operationId" : "getPolicyAlertGroupsForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsForDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsForDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent policy alerts for device, grouped by time", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertGroupsForLocation" : { "post" : { "description" : "Get recent policy alerts for a location, grouped by time. Groups are constructed of alerts that occur within 2 minutes of the previous alert, up to a maximum of 50. Results are returned in reverse-chronological order, so all fields are relative to that ordering.", "operationId" : "getPolicyAlertGroupsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent policy alerts for a location, grouped by time", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertGroupsV2" : { "post" : { "deprecated" : true, "description" : "Get recent policy alerts for organization, grouped by time. Groups are constructed of alerts that occur within 2 minutes of the previous alert, up to a maximum of 50. Results are returned in reverse-chronological order, so all fields are relative to that ordering.", "operationId" : "getPolicyAlertGroupsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertGroupsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent policy alerts for organization, grouped by time", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertV2" : { "post" : { "deprecated" : true, "description" : "Get information about a policy alert", "operationId" : "getPolicyAlertV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get information about a policy alert", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlerts" : { "post" : { "description" : "Get recent policy alerts for organization", "operationId" : "getPolicyAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent policy alerts for organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getPolicyAlertsV2" : { "post" : { "deprecated" : true, "description" : "Get recent policy alerts for organization", "operationId" : "getPolicyAlertsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetPolicyAlertsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent policy alerts for organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getSavedClipCount" : { "post" : { "description" : "Get a count of saved clips in and organization", "operationId" : "getSavedClipCount", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipCountWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipCountWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a count of saved clips in an organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getSavedClipDetails" : { "post" : { "description" : "Get detailed information about a saved clip, including seekpoints and bounding boxes", "operationId" : "getSavedClipDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get detailed information about a saved clip, including seekpoints and bounding boxes", "tags" : [ "Event Webservice" ] } }, "/api/event/getSavedClips" : { "post" : { "deprecated" : true, "description" : "Use /getSavedClipsV2 instead", "operationId" : "getSavedClips", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Use /getSavedClipsV2 instead", "tags" : [ "Event Webservice" ] } }, "/api/event/getSavedClipsByExternalTransactionId" : { "post" : { "description" : "Get list of saved clips matching the external transaction id", "operationId" : "getSavedClipsByExternalTransactionId", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsByExternalTransactionIdWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsByExternalTransactionIdWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of saved clips matching the external transaction id", "tags" : [ "Event Webservice" ] } }, "/api/event/getSavedClipsV2" : { "post" : { "description" : "Get list of saved clips in organization", "operationId" : "getSavedClipsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSavedClipsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of saved clips in organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getSharedClipGroupDetails" : { "post" : { "description" : "Get detailed information about a shared clip page, including seekpoints and bounding boxes", "operationId" : "getSharedClipGroupDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSharedClipGroupDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSharedClipGroupDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get detailed information about a shared clip page, including seekpoints and bounding boxes", "tags" : [ "Event Webservice" ] } }, "/api/event/getSharedClipGroupsV2" : { "post" : { "description" : "Get list of shared clip pages in organization", "operationId" : "getSharedClipGroupsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSharedClipGroupsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSharedClipGroupsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of shared clip pages in organization", "tags" : [ "Event Webservice" ] } }, "/api/event/getSplicedClipsInProgress" : { "post" : { "deprecated" : true, "description" : "Get spliced clips in progress", "operationId" : "DEPRECATED_getSplicedClipsInProgress", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSplicedClipsInProgressWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetSplicedClipsInProgressWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get spliced clips in progress", "tags" : [ "Event Webservice" ] } }, "/api/event/getUnhealthyDeviceAlerts" : { "post" : { "description" : "Get list of unhealthy devices in organization", "operationId" : "getUnhealthyDeviceAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetUnhealthyDeviceAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_GetUnhealthyDeviceAlertsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of unhealthy devices in organization", "tags" : [ "Event Webservice" ] } }, "/api/event/muteNotificationsForDevice" : { "post" : { "description" : "Mute notifications from a device for specified number of seconds", "operationId" : "muteNotificationsForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_MuteNotificationsForDevicetWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_MuteNotificationsForDevicetWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Mute notifications from a device for specified number of seconds", "tags" : [ "Event Webservice" ] } }, "/api/event/reportBadPolicyAlert" : { "post" : { "description" : "Report a bad policy event (AI false positive) and send information for feedback. Note: this adds the clip to our AI training data set", "operationId" : "reportBadPolicyAlert", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_ReportBadPolicyAlertWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_ReportBadPolicyAlertWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Report a bad policy event (AI false positive) and send information for feedback", "tags" : [ "Event Webservice" ] } }, "/api/event/savePolicyAlertV2" : { "post" : { "description" : "Save a policy alert as a saved clip", "operationId" : "savePolicyAlertV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SavePolicyAlertWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SavePolicyAlertWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Save a policy alert as a saved clip", "tags" : [ "Event Webservice" ] } }, "/api/event/searchMotionGrid" : { "post" : { "description" : "Search motion grid for motion events occuring in specified grid cells. Note: motion grid is a 64x36 grid of cells with the upper left hand corner being (0, 0)", "operationId" : "searchMotionGrid", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search motion grid for motion events occuring in specified grid cells", "tags" : [ "Event Webservice" ] } }, "/api/event/searchMotionGridWithActivities" : { "post" : { "description" : "Search motion grid for motion events occuring in specified grid cells. Note: motion grid is a 64x36 grid of cells with the upper left hand corner being (0, 0)", "operationId" : "searchMotionGridWithActivities", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search motion grid for motion events occuring in specified grid cells", "tags" : [ "Event Webservice" ] } }, "/api/event/unSavePolicyAlertV2" : { "post" : { "deprecated" : true, "description" : "Unsave policy alert and remove associated saved clip", "operationId" : "unSavePolicyAlertV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UnSavePolicyAlertWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UnSavePolicyAlertWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unsave policy alert and remove associated saved clip", "tags" : [ "Event Webservice" ] } }, "/api/event/updateSavedClip" : { "post" : { "description" : "Selectively updates a saved clip", "operationId" : "updateSavedClip", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UpdateSavedClipWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UpdateSavedClipWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Selectively update a saved clip", "tags" : [ "Event Webservice" ] } }, "/api/event/updateSharedClipGroupV2" : { "post" : { "description" : "Update shared clip page title, description, password, or expiration time", "operationId" : "updateSharedClipGroupV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UpdateSharedClipGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Event_UpdateSharedClipGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update shared clip page title, description, password, or expiration time", "tags" : [ "Event Webservice" ] } }, "/api/eventSearch/getCameraOrDoorbellCameraSeekpoints" : { "post" : { "deprecated" : true, "description" : "Get camera or doorbell camera seekpoints", "operationId" : "getCameraOrDoorbellCameraSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetCameraOrDoorbellCameraSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Eventsearch_GetCameraOrDoorbellCameraSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera or doorbell camera seekpoints", "tags" : [ "Event Search Webservice" ] } }, "/api/eventSearch/getEventSeekpoints" : { "post" : { "deprecated" : true, "description" : "Get normal seekpoint events and access control seekpoint events", "operationId" : "getDeprecatedEventSeekpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Eventsearch_GetEventSeekpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Eventsearch_GetEventSeekpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get normal seekpoint events and access control seekpoint events", "tags" : [ "Event Search Webservice" ] } }, "/api/export/audit" : { "post" : { "description" : "Download audit log", "operationId" : "exportAudit", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportAuditEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download audit log", "tags" : [ "Export Webservice" ] } }, "/api/export/climateEvents" : { "post" : { "description" : "Download climate event log", "operationId" : "exportClimateEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportClimateEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download climate event log", "tags" : [ "Export Webservice" ] } }, "/api/export/countReports" : { "post" : { "description" : "Download count report", "operationId" : "exportCountReports", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportCountReportsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download count report", "tags" : [ "Export Webservice" ] } }, "/api/export/diagnostic" : { "post" : { "description" : "Download diagnostic log", "operationId" : "exportDiagnostic", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportDiagnosticEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download diagnostic log", "tags" : [ "Export Webservice" ] } }, "/api/export/doorEvents" : { "post" : { "description" : "Download door event log", "operationId" : "exportDoorEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportDoorEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download door event log", "tags" : [ "Export Webservice" ] } }, "/api/export/environmentalGatewayEvents" : { "post" : { "description" : "Download environmental gateway event log", "operationId" : "exportEnvironmentalGatewayEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportEnvironmentalGatewayEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download environmental gateway event log", "tags" : [ "Export Webservice" ] } }, "/api/export/inventory" : { "post" : { "description" : "Download device inventory", "operationId" : "exportInventory", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportInventoryWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download device inventory", "tags" : [ "Export Webservice" ] } }, "/api/export/motionEvents" : { "post" : { "description" : "Download motion event log for motion sensors", "operationId" : "exportMotionEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportMotionEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download motion event log for motion sensors", "tags" : [ "Export Webservice" ] } }, "/api/export/peopleCountEvents" : { "post" : { "description" : "Download people count report", "operationId" : "exportPeopleCountEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportPeopleCountEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download people count report", "tags" : [ "Export Webservice" ] } }, "/api/export/proximityEvents" : { "post" : { "description" : "Download proximity tag event log", "operationId" : "exportProximityEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportProximityEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download proximity tag event log", "tags" : [ "Export Webservice" ] } }, "/api/export/proximityLocomotionEvents" : { "post" : { "description" : "Download proximity tag event log", "operationId" : "exportProximityLocomotionEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportProximityLocomotionEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download proximity tag event log", "tags" : [ "Export Webservice" ] } }, "/api/export/uptime" : { "post" : { "description" : "Download device uptime reports", "operationId" : "exportUptime", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportUptimeWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/zip" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download device uptime reports", "tags" : [ "Export Webservice" ] } }, "/api/export/users" : { "post" : { "description" : "Download org users", "operationId" : "exportUsers", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportUsersWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download org users", "tags" : [ "Export Webservice" ] } }, "/api/export/vehicleEvents" : { "post" : { "deprecated" : true, "description" : "Download vehicle event log. Use /export/vehicleEventsV2 instead for more functionality", "operationId" : "exportVehicleEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Export_ExportVehicleEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download vehicle event log", "tags" : [ "Export Webservice" ] } }, "/api/export/vehicleEventsV2" : { "post" : { "description" : "Download vehicle event log", "operationId" : "exportVehicleEventsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "text/csv; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StreamingOutput" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Download vehicle event log", "tags" : [ "Export Webservice" ] } }, "/api/faceRecognition/faceEvent/deleteFaceEvent" : { "post" : { "description" : "Delete face event.", "operationId" : "deleteFaceEvent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_DeleteFaceEventWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_DeleteFaceEventWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete face event", "tags" : [ "Face Recognition Event Webservice" ] } }, "/api/faceRecognition/faceEvent/findFaceEventsByOrg" : { "post" : { "description" : "Find face events for an organization. The events are returned in reverse chronological order, with the latest events appearing first.", "operationId" : "findFaceEventsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_FindFaceEventsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_FindFaceEventsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find face events by organization", "tags" : [ "Face Recognition Event Webservice" ] } }, "/api/faceRecognition/faceEvent/getFaceEvent" : { "post" : { "description" : "Get face event.", "operationId" : "getFaceEvent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_GetFaceEventWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_GetFaceEventWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get face event", "tags" : [ "Face Recognition Event Webservice" ] } }, "/api/faceRecognition/faceEvent/updateFaceEvent" : { "post" : { "description" : "Update face event.", "operationId" : "updateFaceEvent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_UpdateFaceEventWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_UpdateFaceEventWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update face event", "tags" : [ "Face Recognition Event Webservice" ] } }, "/api/faceRecognition/matchmaker/createFaceMatchmakerFromSighting" : { "post" : { "description" : "Create face matchmaker from face sighting.", "operationId" : "createFaceMatchmakerFromSighting", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create face matchmaker from sighting", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/deleteFaceMatchmaker" : { "post" : { "description" : "Delete face matchmaker.", "operationId" : "deleteFaceMatchmaker", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_DeleteFaceMatchmakerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_DeleteFaceMatchmakerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete face matchmaker", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/findFaceMatchmakersByOrg" : { "post" : { "description" : "Find face matchmakers by org.", "operationId" : "findFaceMatchmakersByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find face matchmakers by org", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/findFaceMatchmakersByPerson" : { "post" : { "description" : "Find face matchmakers by person.", "operationId" : "findFaceMatchmakersByPerson", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find face matchmakers by person", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/findFaceUploadMetadataByTransaction" : { "post" : { "description" : "Find face upload metadata by transaction.", "operationId" : "findFaceUploadMetadataByTransaction", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find face upload metadata by transaction", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/getFaceMatchingConfig" : { "post" : { "description" : "Get face matching configuration.", "operationId" : "getFaceMatchingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_GetFaceMatchingConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_GetFaceMatchingConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get face matching configuration", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/getFaceMatchmaker" : { "post" : { "description" : "Get face matchmaker.", "operationId" : "getFaceMatchmaker", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_GetFaceMatchmakerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_GetFaceMatchmakerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get face matchmaker", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/updateFaceMatchingConfig" : { "post" : { "description" : "Update face matching configuration.", "operationId" : "updateFaceMatchingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_UpdateFaceMatchingConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_UpdateFaceMatchingConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update face matching configuration", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/matchmaker/uploadFaceMatchmakers" : { "post" : { "description" : "Upload face matchmaker images for one or more people. The uploaded file name is matched to a person's name. If a person is not found and createPersonIfNotFound is set to true, a new person is created. ", "operationId" : "uploadFaceMatchmakers", "parameters" : [ { "description" : "Unique transaction id to track the face matchmakers upload progress. If not specified, the system will generate it.", "in" : "query", "name" : "transaction", "schema" : { "type" : "string", "nullable" : true } }, { "description" : "If a person is not found and createPersonIfNotFound is set to true, a new person is created", "in" : "query", "name" : "createPersonIfNotFound", "schema" : { "type" : "boolean", "nullable" : true } }, { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } }, "description" : "Multipart form-data containing a .jpg or .png file. Maximum file size: 5MB." }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_UploadFaceMatchmakersWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload face matchmakers", "tags" : [ "Face Recognition Matchmaker Webservice" ] } }, "/api/faceRecognition/person/addPersonLabel" : { "post" : { "description" : "Add a label to a person", "operationId" : "addPersonLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_AddPersonLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_AddPersonLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Add a label to a person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/createPerson" : { "post" : { "description" : "Create a person for face recognition purposes.", "operationId" : "createPerson", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_CreatePersonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_CreatePersonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create a person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/deletePerson" : { "post" : { "description" : "Delete person created for face recognition purposes.", "operationId" : "deletePerson", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_DeletePersonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_DeletePersonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/findPeopleByOrg" : { "post" : { "description" : "Find people created for face recognition purposes in an organization.", "operationId" : "findPeopleByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_FindPeopleByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_FindPeopleByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find people by organization", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/findPersonLabelsByOrg" : { "post" : { "description" : "Find all person labels for organization.", "operationId" : "findPersonLabelsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_FindPersonLabelsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_FindPersonLabelsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all person labels for organization", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/getPerson" : { "post" : { "description" : "Get a person created for face recognition purposes.", "operationId" : "getPerson", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_GetPersonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_GetPersonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get a person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/removePersonLabel" : { "post" : { "description" : "Remove a label from a person.", "operationId" : "removePersonLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_RemovePersonLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_RemovePersonLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove a label from a person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/faceRecognition/person/updatePerson" : { "post" : { "description" : "Update person created for face recognition purposes.", "operationId" : "updatePerson", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_UpdatePersonWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Facerecognition_person_UpdatePersonWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update person", "tags" : [ "Face Recognition Person Webservice" ] } }, "/api/feature/getDeviceEventTypes" : { "post" : { "description" : "Get possible event types for specified device dependent on features enabled", "operationId" : "getDeviceEventTypes", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceEventTypesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceEventTypesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get possible event types for specified device", "tags" : [ "Feature Webservice" ] } }, "/api/feature/getDeviceFeatures" : { "post" : { "description" : "Get enabled features for a device", "operationId" : "getDeviceFeatures", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceFeaturesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceFeaturesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get enabled features for a device", "tags" : [ "Feature Webservice" ] } }, "/api/feature/getDeviceFeaturesList" : { "post" : { "description" : "Get enabled features for all devices in an org", "operationId" : "getDeviceFeaturesList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceFeaturesListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetDeviceFeaturesListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get enabled features for all devices in an org", "tags" : [ "Feature Webservice" ] } }, "/api/feature/getFeatureCompatabilityMatrix" : { "post" : { "description" : "Get feature compatability matrix", "operationId" : "getFeatureCompatabilityMatrix", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetFeatureCompatabilityMatrixWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_GetFeatureCompatabilityMatrixWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get feature compatibility matrix", "tags" : [ "Feature Webservice" ] } }, "/api/feature/updateDeviceFeatures" : { "post" : { "description" : "Update enabled features for a device", "operationId" : "updateDeviceFeatures", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_UpdateDeviceFeaturesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Feature_UpdateDeviceFeaturesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update enabled features for a device", "tags" : [ "Feature Webservice" ] } }, "/api/help/feedback" : { "post" : { "description" : "Leave feedback of our system", "operationId" : "sendFeedback", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_SendFeedbackWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_SendFeedbackWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Leave feedback of our system", "tags" : [ "Help Webservice" ] } }, "/api/help/openTickets" : { "post" : { "deprecated" : true, "description" : "Get Open Support Tickets For A Client Organization. Tickets are associated to an organziation based on the requester's organization association.\nThis endpoint returns a paginated response sorted by the request date. The first page is indexed at 1 and each page has up to 100 ticket entries.", "operationId" : "getOpenTickets", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_GetOpenTicketsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_GetOpenTicketsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get open support tickets for a client organization", "tags" : [ "Help Webservice" ] } }, "/api/help/openTicketsV2" : { "post" : { "description" : "Get Open Support Tickets For A Client Organization. Tickets are associated to an organziation based on the requester's organization association.", "operationId" : "getOpenTicketsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_GetOpenTicketsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_GetOpenTicketsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get open support tickets for a client organization V2", "tags" : [ "Help Webservice" ] } }, "/api/help/rma" : { "post" : { "description" : "Open an RMA for a camera", "operationId" : "processRMA", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_ProcessRMAWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_ProcessRMAWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Open an RMA for a camera", "tags" : [ "Help Webservice" ] } }, "/api/help/ticket" : { "post" : { "description" : "Open a support ticket", "operationId" : "createTicket", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_CreateTicketWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_CreateTicketWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Open a support ticket", "tags" : [ "Help Webservice" ] } }, "/api/help/ticketWithFile" : { "post" : { "description" : "Open a support ticket and optionally include a file upload. Uploading multiple Files are not supported throught this call.", "operationId" : "createTicketWithFile", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } }, "description" : "multipart/form-data with field 'file' for the file and 'request' for the CreateTicketWSRequest(see '/ticket' for details on CreateTicketWSRequest)" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_CreateTicketWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Open a support ticket with file upload", "tags" : [ "Help Webservice" ] } }, "/api/help/triageDevice" : { "post" : { "description" : "Triage a device connection/recording issue", "operationId" : "triageDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_TriageDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Help_TriageDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Triage a device connection/recording issue", "tags" : [ "Help Webservice" ] } }, "/api/integrations/IoT/deleteHaloIntegration" : { "post" : { "description" : "Delete Halo Smart Sensor integration", "operationId" : "deleteHaloIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Halo Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/deleteIntuifaceIntegration" : { "post" : { "description" : "Delete Intuiface integration", "operationId" : "deleteIntuifaceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Intuiface Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/deleteOmnialertIntegration" : { "post" : { "description" : "Delete Omnialert integration", "operationId" : "deleteOmnialertIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Omnialert Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/deleteShellyIntegration" : { "post" : { "description" : "Delete Shelly integration", "operationId" : "deleteShellyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Shelly Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/deleteTritonIntegration" : { "post" : { "description" : "Delete Triton audio sensor integration", "operationId" : "deleteTritonIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Triton Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/getOmnialertIntegration" : { "post" : { "description" : "Get Omnialert integration", "operationId" : "getOmnialertIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Omnialert Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/getShellyIntegration" : { "post" : { "description" : "Get Shelly integration", "operationId" : "getShellyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Shelly Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/updateHaloIntegration" : { "post" : { "description" : "Update Halo Smart Sensor integration", "operationId" : "updateHaloIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateHaloIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Halo Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/updateIntuifaceIntegration" : { "post" : { "description" : "Update Intuiface integration", "operationId" : "updateIntuifaceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateIntuifaceIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Intuiface Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/updateOmnialertIntegration" : { "post" : { "description" : "Update Omnialert integration", "operationId" : "updateOmnialertIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOmnialertIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOmnialertIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Omnialert Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/updateShellyIntegration" : { "post" : { "description" : "Update Shelly rules engine integration", "operationId" : "updateShellyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateShellyIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Shelly Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/IoT/updateTritonIntegration" : { "post" : { "description" : "Update Triton audio sensor integration", "operationId" : "updateTritonIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateTritonIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Triton Integration", "tags" : [ "IoT Integrations Webservice" ] } }, "/api/integrations/accessControl/connectHoneywellElements" : { "post" : { "description" : "Step 1 of the Elements setup wizard: validate the API key against Honeywell Elements and persist on success. After this call, subsequent endpoints (sites, devices, update) resolve credentials from the stored row and never require the API key again.", "operationId" : "connectHoneywellElements", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ConnectHoneywellElementsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Connect Honeywell Elements (validate + persist)", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/connectHoneywellNetBox" : { "post" : { "description" : "Activate the Honeywell NetBox integration for the calling org. NetBox is webhook-driven: the on-prem NetBox controller POSTs access events to a Rhombus webhook URL. On first activation the server generates the webhook rhombusToken and returns it (plus the fully-formed webhook URL); subsequent calls preserve the token so the configured forwarder keeps working as the door mapping changes. The request owns the door mapping and optional base URL.", "operationId" : "connectHoneywellNetBox", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ConnectHoneywellNetBoxWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ConnectHoneywellNetBoxIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Connect Honeywell NetBox (activate)", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration" : { "post" : { "description" : "Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory; the console owns camera/location assignments. First activation (blank rhombusToken, no existing integration) generates the webhook token; re-calls merge the door map by portal key without overwriting console-made assignments, and keys absent from the request are preserved.", "operationId" : "createOrUpdateHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create or update Honeywell NetBox integration (on-prem connector)", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/createOrUpdateHoneywellOnGuardIntegration" : { "post" : { "description" : "Idempotent activation/update endpoint called by the OnGuard side from its setup tool. Generates the webhook token and pre-shared HMAC secret on first call; preserves both on subsequent calls so the deployed DLL keeps working as the door mapping changes. The request owns the door mapping; behavior flags (face recognition, clip saving, etc.) are managed separately from the Rhombus console.", "operationId" : "createOrUpdateHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create or update the Honeywell OnGuard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteAmtIntegration" : { "post" : { "description" : "Delete Amt badge integration", "operationId" : "deleteAmtIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete AMT badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteAvigilonAltaIntegrationV2" : { "post" : { "description" : "Delete Avigilon Alta badge integration V2", "operationId" : "deleteAvigilonAltaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Avigilon Alta badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteBoulevardIntegration" : { "post" : { "description" : "Delete Boulevard integration settings", "operationId" : "deleteBoulevardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Boulevard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteBrivoIntegration" : { "post" : { "description" : "Delete Brivo badge integration", "operationId" : "deleteBrivoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Brivo badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteBrivoIntegrationV2" : { "post" : { "description" : "Delete Brivo badge integration V2", "operationId" : "deleteBrivoIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Brivo badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteButterflymxIntegration" : { "post" : { "description" : "Delete ButterflyMX badge integration", "operationId" : "deleteButterflymxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete ButterflyMX badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteButterflymxIntegrationV2" : { "post" : { "description" : "Delete ButterflyMX badge integration V2", "operationId" : "deleteButterflymxIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete ButterflyMX badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteGeneaIntegration" : { "post" : { "description" : "Delete Genea badge integration", "operationId" : "deleteGeneaIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Genea badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteGeneaIntegrationV2" : { "post" : { "description" : "Delete Genea badge integration V2", "operationId" : "deleteGeneaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Genea badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteHoneywellElementsIntegration" : { "post" : { "description" : "Delete Honeywell Elements integration", "operationId" : "deleteHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteHoneywellNetBoxIntegration" : { "post" : { "description" : "Delete Honeywell NetBox integration", "operationId" : "deleteHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Honeywell NetBox integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteHoneywellOnGuardIntegration" : { "post" : { "description" : "Delete Honeywell OnGuard integration. Callable from the Rhombus console (admin) or from the OnGuard side (uninstall). Idempotent per deployment: deleting a rhombusToken that is unknown or already deleted returns success, so the client may safely retry after a network failure.", "operationId" : "deleteHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_DeleteHoneywellOnGuardIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Honeywell OnGuard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteInnerRangeIntegration" : { "post" : { "description" : "Delete Inner Range integration", "operationId" : "deleteInnerRangeIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Inner Range integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteKisiIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Kisi badge integration", "operationId" : "deleteKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Kisi badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteKisiIntegrationV2" : { "post" : { "description" : "Delete Kisi badge integration V2", "operationId" : "deleteKisiIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Kisi badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteOpenpathIntegration" : { "post" : { "description" : "Delete Openpath badge integration", "operationId" : "deleteOpenpathIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Openpath badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteOpentechAllianceIntegration" : { "post" : { "description" : "Delete Opentech Alliance integration", "operationId" : "deleteOpentechAllianceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Opentech Alliance integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deleteOpentechAllianceIntegrationV2" : { "post" : { "description" : "Delete Opentech Alliance integration", "operationId" : "deleteOpentechAllianceIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Opentech Alliance integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deletePdkIntegration" : { "post" : { "description" : "Delete ProDataKey badge integration", "operationId" : "deletePdkIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete ProDataKey badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deletePdkIntegrationV2" : { "post" : { "description" : "Delete ProDataKey badge integration", "operationId" : "deletePdkIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete ProDataKey badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deletePlaceOsIntegration" : { "post" : { "description" : "Delete PlaceOs badge integration", "operationId" : "deletePlaceOsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete PlaceOs badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/deletePlaceOsIntegrationV2" : { "post" : { "description" : "Delete PlaceOs badge integration", "operationId" : "deletePlaceOsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete PlaceOs badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getAmtReaders" : { "post" : { "description" : "Get list of AMT readers to assign cameras", "operationId" : "getAmtReaders", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetAmtReadersWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of AMT readers to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getAvigilonAltaIntegration" : { "post" : { "description" : "Get Avigilon Alta integration", "operationId" : "getAvigilonAltaIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Avigilon Alta integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getBoulevardIntegration" : { "post" : { "description" : "Get Boulevard integration settings", "operationId" : "getBoulevardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBoulevardIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Boulevard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getBrivoDoors" : { "post" : { "description" : "Get list of available Brivo doors to assign cameras", "operationId" : "getBrivoDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available Brivo doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getBrivoDoorsV2" : { "post" : { "description" : "Get list of available Brivo doors to assign cameras", "operationId" : "getBrivoDoorsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available Brivo doors to assign cameras V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getBrivoDoorsV3" : { "post" : { "description" : "Get list of available Brivo doors to assign cameras", "operationId" : "getBrivoDoorsV3", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBrivoDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available Brivo doors to assign cameras V3", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getBrivoIntegrationV2" : { "post" : { "description" : "Get Brivo badge integration", "operationId" : "getBrivoIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Brivo badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getButterflymxIntegrationV2" : { "post" : { "description" : "Get ButterflyMX badge integration", "operationId" : "getButterflymxIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get ButterflyMX badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getButterflymxPanels" : { "post" : { "description" : "Get list of available ButterflyMX panels to assign cameras", "operationId" : "getButterflymxPanels", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetButterflymxPanelsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetButterflymxPanelsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available ButterflyMX panels to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getButterflymxPanelsV2" : { "post" : { "description" : "Get list of available ButterflyMX panels to assign cameras", "operationId" : "getButterflymxPanelsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetButterflymxPanelsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetButterflymxPanelsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available ButterflyMX panels to assign cameras V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getGeneaDoors" : { "post" : { "description" : "Get list of Genea doors to assign cameras", "operationId" : "getGeneaDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetGeneaDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetGeneaDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Genea doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getGeneaIntegration" : { "post" : { "description" : "Get Genea integration", "operationId" : "getGeneaIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Genea integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellElementsDevices" : { "post" : { "description" : "Get list of available Honeywell Elements devices to assign cameras", "operationId" : "getHoneywellElementsDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Honeywell Elements devices", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellElementsIntegration" : { "post" : { "description" : "Get Honeywell Elements integration settings", "operationId" : "getHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellElementsSites" : { "post" : { "description" : "Get list of available Honeywell Elements sites", "operationId" : "getHoneywellElementsSites", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ValidateHoneywellElementsCredentialsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsSitesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Honeywell Elements sites", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellElementsWebhookConfig" : { "post" : { "description" : "Returns the callback URL and suggested payload template the customer needs to paste into the Elements admin console when creating their webhook Automation. Elements does not support programmatic webhook creation, so this endpoint is the setup aid instead of a registration call.", "operationId" : "getHoneywellElementsWebhookConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsWebhookConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Honeywell Elements webhook config", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellNetBoxIntegration" : { "post" : { "description" : "Get Honeywell NetBox integration settings", "operationId" : "getHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Honeywell NetBox integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellNetBoxWebhookConfig" : { "post" : { "description" : "Returns the fully-formed callback URL and a suggested JSON payload template to configure in the Honeywell NetBox webhook forwarder. The integration must be activated (connectHoneywellNetBox) first so a webhook token exists; the returned URL is keyed off that token.", "operationId" : "getHoneywellNetBoxWebhookConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetHoneywellNetBoxWebhookConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Honeywell NetBox webhook config", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getHoneywellOnGuardIntegration" : { "post" : { "description" : "Get Honeywell OnGuard integration settings, including the webhook URL and pre-shared secret (always retrievable for support/debugging).", "operationId" : "getHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Honeywell OnGuard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getInnerRangeConsoles" : { "post" : { "description" : "Get Inner Range console settings", "operationId" : "getInnerRangeConsoles", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Inner Range console settings", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getInnerRangeDoors" : { "post" : { "deprecated" : true, "description" : "Get list of Inner Range doors", "operationId" : "getInnerRangeDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Inner Range doors", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getInnerRangeIntegration" : { "post" : { "description" : "Get Inner Range integration", "operationId" : "getInnerRangeIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Inner Range integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getKisiDoors" : { "post" : { "deprecated" : true, "description" : "Get list of Kisi doors to assign cameras", "operationId" : "getKisiDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Kisi doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getKisiIntegration" : { "post" : { "deprecated" : true, "description" : "Get Kisi badge integration", "operationId" : "getKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetKisiIntegrationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Kisi badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getKisiIntegrationV2" : { "post" : { "description" : "Get Kisi badge integration V2", "operationId" : "getKisiIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Kisi badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getKisiPlaces" : { "post" : { "deprecated" : true, "description" : "Get list of Kisi places to assign cameras", "operationId" : "getKisiPlaces", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetKisiPlacesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationPlacesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Kisi places to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getOpenpathDoors" : { "post" : { "description" : "Get list of Openpath doors to assign cameras", "operationId" : "getOpenpathDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Openpath doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getOpenpathLockdownPlans" : { "post" : { "description" : "Get list of Openpath lockdown plans to trigger", "operationId" : "getOpenpathLockdownPlans", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenpathLockdownsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Openpath lockdown plans to trigger", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getOpentechAllianceFacilities" : { "post" : { "description" : "Get list of Opentech Alliance facilities", "operationId" : "getOpentechAllianceFacilities", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Opentech Alliance facilities", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getOpentechAllianceFacilitiesV2" : { "post" : { "description" : "Get list of Opentech Alliance facilities", "operationId" : "getOpentechAllianceFacilitiesV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of Opentech Alliance facilities V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getOpentechAllianceIntegrationV2" : { "post" : { "description" : "Get Opentech Alliance integration", "operationId" : "getOpentechAllianceIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Opentech Alliance integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getPdkDoors" : { "post" : { "description" : "Get list of ProDataKey doors to assign cameras", "operationId" : "getPdkDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of ProDataKey doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getPdkIntegration" : { "post" : { "description" : "Get ProDataKey badge integration", "operationId" : "getPdkIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get ProDataKey badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getPlaceOsDoors" : { "post" : { "description" : "Get list of PlaceOs doors to assign cameras", "operationId" : "getPlaceOsDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetPlaceOsDoorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationGenericDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of PlaceOs doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/getPlaceOsIntegrationV2" : { "post" : { "description" : "Get PlaceOs integration", "operationId" : "getPlaceOsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get PlaceOs integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/listHoneywellOnGuardIntegrations" : { "post" : { "description" : "List the calling org's OnGuard deployments: one summary per activated deployment (rhombusToken, display name, door count, assigned camera UUIDs). Lets the OnGuard setup tool show what already exists before minting a new deployment, and identifies orphans to pass to deleteHoneywellOnGuardIntegration. Pre-shared secrets are never returned.", "operationId" : "listHoneywellOnGuardIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ListHoneywellOnGuardIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ListHoneywellOnGuardIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "List Honeywell OnGuard deployments", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/revertOpenpathLockdown" : { "post" : { "description" : "Revert Openpath lockdown plan", "operationId" : "revertOpenpathLockdown", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revert Openpath lockdown plan", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/testBoulevardConnection" : { "post" : { "description" : "Test Boulevard API connection with provided credentials", "operationId" : "testBoulevardConnection", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Test Boulevard API connection", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/triggerOpenpathLockdown" : { "post" : { "description" : "Trigger Openpath lockdown plan", "operationId" : "triggerOpenpathLockdown", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Trigger Openpath lockdown plan", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockBrivoDoor" : { "post" : { "description" : "Unlock Brivo door", "operationId" : "unlockBrivoDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Brivo door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockBrivoDoorV2" : { "post" : { "description" : "Unlock Brivo door", "operationId" : "unlockBrivoDoorV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Brivo door V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockGeneaDoor" : { "post" : { "description" : "Unlock Genea door", "operationId" : "unlockGeneaDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockGeneaDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Genea door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockHoneywellElementsDoor" : { "post" : { "description" : "Unlock Honeywell Elements door", "operationId" : "unlockHoneywellElementsDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Honeywell Elements door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockHoneywellNetBoxDoor" : { "post" : { "description" : "Publishes an unlock command to the per-org STOMP topic that the NetBox connector subscribes to. Fire-and-forget: returns success once the command is dispatched, the connector performs the actual relay and does not currently report back.", "operationId" : "unlockHoneywellNetBoxDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Honeywell NetBox door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockHoneywellOnGuardDoor" : { "post" : { "description" : "Publishes an unlock command to the per-org STOMP topic that the OnGuard connector subscribes to. Fire-and-forget: returns success once the command is dispatched, the connector performs the actual relay and does not currently report back.", "operationId" : "unlockHoneywellOnGuardDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Honeywell OnGuard door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockInnerRangeDoor" : { "post" : { "description" : "Unlock Inner Range door", "operationId" : "unlockInnerRangeDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Inner Range door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockKisiDoor" : { "post" : { "description" : "Unlock Kisi door", "operationId" : "unlockKisiDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockKisiDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Kisi door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockOpenpathDoor" : { "post" : { "description" : "Unlock Openpath door", "operationId" : "unlockOpenpathDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Openpath door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockOpentechAllianceDoor" : { "post" : { "description" : "Unlock Opentech Alliance door", "operationId" : "unlockOpentechAllianceDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Opentech Alliance door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockOpentechAllianceDoorV2" : { "post" : { "description" : "Unlock Opentech Alliance door", "operationId" : "unlockOpentechAllianceDoorV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock Opentech Alliance door V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockPdkDoor" : { "post" : { "description" : "Unlock ProDataKey door", "operationId" : "unlockPdkDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock ProDataKey door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/unlockPlaceOsDoor" : { "post" : { "description" : "Unlock PlaceOs door", "operationId" : "unlockPlaceOsDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unlock PlaceOs door", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateAmtIntegration" : { "post" : { "description" : "Update Amt badge integration", "operationId" : "updateAmtIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update AMT badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateAvigilonAltaIntegrationV2" : { "post" : { "description" : "Update Avigilon Alta badge integration V2", "operationId" : "updateAvigilonAltaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateAvigilonAltaV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Avigilon Alta badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateBoulevardIntegration" : { "post" : { "description" : "Update Boulevard integration settings", "operationId" : "updateBoulevardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateBoulevardIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Boulevard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateBrivoIntegration" : { "post" : { "description" : "Update Brivo badge integration", "operationId" : "updateBrivoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Brivo badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateBrivoIntegrationV2" : { "post" : { "description" : "Update Brivo badge integration", "operationId" : "updateBrivoIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Brivo badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateButterflymxIntegration" : { "post" : { "description" : "Update ButterflyMX badge integration", "operationId" : "updateButterflymxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update ButterflyMX badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateButterflymxIntegrationV2" : { "post" : { "description" : "Update ButterflyMX badge integration V2", "operationId" : "updateButterflymxIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update ButterflyMX badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateGeneaIntegration" : { "post" : { "description" : "Update Genea badge integration", "operationId" : "updateGeneaIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Genea badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateGeneaIntegrationV2" : { "post" : { "description" : "Update Genea badge integration V2", "operationId" : "updateGeneaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Genea badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateHoneywellElementsIntegration" : { "post" : { "description" : "Update Honeywell Elements integration settings", "operationId" : "updateHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateHoneywellElementsIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateHoneywellNetBoxIntegration" : { "post" : { "description" : "Update Honeywell NetBox integration settings (behavior flags, door mapping)", "operationId" : "updateHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateHoneywellNetBoxIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Honeywell NetBox integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateHoneywellOnGuardIntegration" : { "post" : { "description" : "Update Honeywell OnGuard behavior flags (face recognition, clip saving, etc.) and enabled state. Door mapping is owned by OnGuard and ignored on this endpoint.", "operationId" : "updateHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateHoneywellOnGuardIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Honeywell OnGuard behavior flags", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateInnerRangeIntegration" : { "post" : { "description" : "Update Inner Range integration", "operationId" : "updateInnerRangeIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateInnerRangeIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Inner Range integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateKisiIntegration" : { "post" : { "deprecated" : true, "description" : "Update Kisi badge integration", "operationId" : "updateKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Kisi badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateKisiIntegrationV2" : { "post" : { "description" : "Update Kisi badge integration V2", "operationId" : "updateKisiIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Kisi badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateOpenpathIntegration" : { "post" : { "description" : "Update Openpath badge integration", "operationId" : "updateOpenpathIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOpenpathIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Openpath badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateOpentechAllianceIntegration" : { "post" : { "description" : "Update Opentech Alliance integration", "operationId" : "updateOpentechAllianceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Opentech Alliance integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updateOpentechAllianceIntegrationV2" : { "post" : { "description" : "Update Opentech Alliance integration", "operationId" : "updateOpentechAllianceIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Opentech Alliance integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updatePdkIntegration" : { "post" : { "description" : "Update ProDataKey badge integration", "operationId" : "updatePdkIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update ProDataKey badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updatePdkIntegrationV2" : { "post" : { "description" : "Update ProDataKey badge integration", "operationId" : "updatePdkIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update ProDataKey badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updatePlaceOsSettings" : { "post" : { "description" : "Update PlaceOs badge integration", "operationId" : "updatePlaceOsSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update PlaceOs badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/updatePlaceOsSettingsV2" : { "post" : { "description" : "Update PlaceOs badge integration", "operationId" : "updatePlaceOsSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update PlaceOs badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/accessControl/validateHoneywellElementsCredentials" : { "post" : { "description" : "Validate Honeywell Elements API credentials", "operationId" : "validateHoneywellElementsCredentials", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_ValidateHoneywellElementsCredentialsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Validate Honeywell Elements API credentials", "tags" : [ "Access Control Integrations Webservice" ] } }, "/api/integrations/deleteAmtIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Amt badge integration", "operationId" : "deleteAmtIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete AMT Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/deleteDeviceIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Device integration", "operationId" : "deleteDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Device Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/deleteMattermostIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Mattermost alert integration", "operationId" : "deleteMattermostIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Mattermost Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/deleteOpenAIIntegration" : { "post" : { "deprecated" : true, "description" : "Delete OpenAI integration", "operationId" : "deleteOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete OpenAI Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/deleteWebhookIntegration" : { "post" : { "deprecated" : true, "description" : "Delete outbound webhook alert integration", "operationId" : "deleteWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Webhook Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/deleteWebhookIntegrationV2" : { "post" : { "deprecated" : true, "description" : "Delete entire webhook integration", "operationId" : "deleteWebhookIntegrationV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Webhook Integration V2", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getAmtReaders" : { "post" : { "deprecated" : true, "description" : "Get list of AMT readers to assign cameras", "operationId" : "getAmtReadersDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetAmtReadersWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get AMT Readers", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getApiTokenApplications" : { "post" : { "deprecated" : true, "description" : "Get details of all open api token requests for organization", "operationId" : "getApiTokenApplicationsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get API Token Applications", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getApiTokens" : { "post" : { "deprecated" : true, "description" : "Get list of all api tokens for organization", "operationId" : "getApiTokensDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get API Tokens", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getCalendlyEventDetails" : { "post" : { "deprecated" : true, "description" : "Get Calendly event details", "operationId" : "getCalendlyEventDetailsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Calendly Event Details", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getDeviceIntegration" : { "post" : { "deprecated" : true, "description" : "Get Device integration", "operationId" : "getDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Device Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getOpenAIIntegration" : { "post" : { "deprecated" : true, "description" : "Get OpenAI integration", "operationId" : "getOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get OpenAI Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getOpenAIModels" : { "post" : { "deprecated" : true, "description" : "Get list of OpenAI models", "operationId" : "getOpenAIModelsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get OpenAI Models", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getOrgIntegrations" : { "post" : { "deprecated" : true, "description" : "Get details of all third-party integrations for organization", "operationId" : "getOrgIntegrationsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Organization Integrations", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getOrgIntegrationsV2" : { "post" : { "deprecated" : true, "description" : "Get details of all V2 third-party integrations for an organization", "operationId" : "getOrgIntegrationsV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Organization Integrations V2", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/getWebhookIntegration" : { "post" : { "deprecated" : true, "description" : "Get webhook integration", "operationId" : "getWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Webhook Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteDiceIntegration" : { "post" : { "description" : "Delete Dice integration", "operationId" : "deleteDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Dice Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteEmailIntegration" : { "post" : { "description" : "Delete email alert integration", "operationId" : "deleteEmailIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Email Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteInformacastIntegration" : { "post" : { "description" : "Delete Informacast integration", "operationId" : "deleteInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Informacast Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteLumeoIntegration" : { "post" : { "description" : "Delete Lumeo integration", "operationId" : "deleteLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Lumeo Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteMattermostIntegration" : { "post" : { "description" : "Delete Mattermost alert integration", "operationId" : "deleteMattermostIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Mattermost Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteMicrosoftTeamsIntegrationV2" : { "post" : { "description" : "Delete Microsoft Teams alert integration", "operationId" : "deleteMicrosoftTeamsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Microsoft Teams Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteMicrosoftTeamsUser" : { "post" : { "description" : "Remove configurations for Microsoft Teams user", "operationId" : "deleteMicrosoftTeamsUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Microsoft Teams User", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteOpenAIIntegration" : { "post" : { "description" : "Delete OpenAI integration", "operationId" : "deleteOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete OpenAI Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deletePagerDutyIntegration" : { "post" : { "description" : "Delete PagerDuty alert integration", "operationId" : "deletePagerDutyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete PagerDuty Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteServiceNowIntegration" : { "post" : { "description" : "Delete ServiceNow alert integration", "operationId" : "deleteServiceNowIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete ServiceNow Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/deleteSlackIntegrationV2" : { "post" : { "description" : "Delete Slack alert integration v2", "operationId" : "deleteSlackIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Slack Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getDiceIntegration" : { "post" : { "description" : "Get Dice integration", "operationId" : "getDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Dice Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getInformacastIntegration" : { "post" : { "description" : "Get Informacast integration", "operationId" : "getInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Informacast Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getInformacastScenarios" : { "post" : { "description" : "Get Informacast scenarios", "operationId" : "getInformacastScenarios", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInformacastScenariosWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Informacast Scenarios", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getInformacastSites" : { "post" : { "description" : "Get Informacast sites for mapping Rhombus locations", "operationId" : "getInformacastSites", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetInformacastSitesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Informacast Sites", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getLumeoIntegration" : { "post" : { "description" : "Get Lumeo integration", "operationId" : "getLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Lumeo Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getMicrosoftTeamsIntegration" : { "post" : { "description" : "Get Microsoft Teams alert integration", "operationId" : "getMicrosoftTeamsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Microsoft Teams Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getMicrosoftUsersJoinedTeams" : { "post" : { "description" : "Get a list of teams a Microsoft Teams user joined", "operationId" : "getMicrosoftUsersJoinedTeams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetMicrosoftUsersJoinedTeamsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Microsoft Users Joined Teams", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getOpenAIIntegration" : { "post" : { "description" : "Get OpenAI integration", "operationId" : "getOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get OpenAI Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/getOpenAIModels" : { "post" : { "description" : "Get list of OpenAI models", "operationId" : "getOpenAIModels", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get OpenAI Models", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/installMicrosoftTeamsBotForTeam" : { "post" : { "description" : "Install notification bot for Microsoft Teams team", "operationId" : "installMicrosoftTeamsBotForTeam", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Install Microsoft Teams Bot For Team", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/installMicrosoftTeamsBotForUser" : { "post" : { "description" : "Install notification bot for Microsoft Teams user", "operationId" : "installMicrosoftTeamsBotForUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Install Microsoft Teams Bot For User", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForTeam" : { "post" : { "description" : "Uninstall notification bot for Microsoft Teams team", "operationId" : "uninstallMicrosoftTeamsBotForTeam", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Uninstall Microsoft Teams Bot For Team", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForUser" : { "post" : { "description" : "Uninstall notification bot for Microsoft Teams user", "operationId" : "uninstallMicrosoftTeamsBotForUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Uninstall Microsoft Teams Bot For User", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateDiceIntegration" : { "post" : { "description" : "Update Dice integration", "operationId" : "updateDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateDiceIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Dice Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateEmailIntegration" : { "post" : { "description" : "Update email alert integration", "operationId" : "updateEmailIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateEmailIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Email Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateInformacastIntegration" : { "post" : { "description" : "Update Informacast rules engine integration", "operationId" : "updateInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateInformacastIntegrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Informacast Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateLumeoIntegration" : { "post" : { "description" : "Update Lumeo integration", "operationId" : "updateLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateLumeoIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Lumeo Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateMattermostIntegration" : { "post" : { "description" : "Update Mattermost alert integration", "operationId" : "updateMattermostIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Mattermost Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateMicrosoftTeamsIntegrationV2" : { "post" : { "description" : "Update Microsoft Teams alert integration", "operationId" : "updateMicrosoftTeamsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Microsoft Teams Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateOpenAIIntegration" : { "post" : { "description" : "Update OpenAI integration", "operationId" : "updateOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update OpenAI Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updatePagerDutyIntegration" : { "post" : { "description" : "Update PagerDuty alert integration", "operationId" : "updatePagerDutyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdatePagerDutyIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update PagerDuty Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateServiceNowIntegration" : { "post" : { "description" : "Update ServiceNow alert integration", "operationId" : "updateServiceNowIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateServiceNowIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update ServiceNow Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateSlackIntegration" : { "post" : { "description" : "Update Slack alert integration", "operationId" : "updateSlackIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Slack Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/incidentManagement/updateSlackIntegrationV2" : { "post" : { "description" : "Update Slack alert integration v2", "operationId" : "updateSlackIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Slack Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, "/api/integrations/org/getApiTokens" : { "post" : { "description" : "Get list of all api tokens for organization", "operationId" : "getApiTokens", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get API tokens", "tags" : [ "Org Integrations Webservice" ] } }, "/api/integrations/org/getOrgIntegrations" : { "post" : { "description" : "Get details of all third-party integrations for organization", "operationId" : "getOrgIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization integrations", "tags" : [ "Org Integrations Webservice" ] } }, "/api/integrations/org/getOrgIntegrationsV2" : { "post" : { "description" : "Get details of all V2 third-party integrations for an organization", "operationId" : "getOrgIntegrationsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization integrations V2", "tags" : [ "Org Integrations Webservice" ] } }, "/api/integrations/org/revokeApiToken" : { "post" : { "description" : "Remove an api token from organization. Note: this is irreversible", "operationId" : "revokeApiToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke API token", "tags" : [ "Org Integrations Webservice" ] } }, "/api/integrations/revokeApiToken" : { "post" : { "deprecated" : true, "description" : "Remove an api token from organization. Note: this is irreversible", "operationId" : "revokeApiTokenDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke API Token", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/serviceManagement/createEnvoyInvite" : { "post" : { "description" : "Create an invite with Envoy", "operationId" : "createEnvoyInvite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_CreateEnvoyInviteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create Envoy invite", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/deleteEnvoyIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Envoy badge integration", "operationId" : "deleteEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Envoy integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/deleteEnvoyIntegrationV2" : { "post" : { "description" : "Delete Envoy integration", "operationId" : "deleteEnvoyIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Envoy integration V2", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/deleteToastIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Toast integration", "operationId" : "deleteToastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Toast integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/deleteToastIntegrationV2" : { "post" : { "description" : "Delete Toast integration", "operationId" : "deleteToastIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Toast integration V2", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/getCalendlyEventDetails" : { "post" : { "description" : "Get Calendly event details", "operationId" : "getCalendlyEventDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Calendly event details", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/getEnvoyIntegration" : { "post" : { "description" : "Get Envoy integration", "operationId" : "getEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Envoy integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/getToastIntegration" : { "post" : { "description" : "Get Toast integration", "operationId" : "getToastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Toast integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/getToastServiceAreas" : { "post" : { "description" : "Get list of Toast service areas to assign cameras", "operationId" : "getToastServiceAreas", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Toast service areas", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/initiateEnvoyOAuth" : { "post" : { "description" : "Initiate the Envoy OAuth Process", "operationId" : "initiateEnvoyOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Initiate Envoy OAuth", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/updateEnvoyIntegration" : { "post" : { "deprecated" : true, "description" : "Update Envoy badge integration", "operationId" : "updateEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Envoy integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/updateEnvoyIntegrationV2" : { "post" : { "description" : "Update Envoy integration", "operationId" : "updateEnvoyIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Envoy integration V2", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/updateToastIntegration" : { "post" : { "deprecated" : true, "description" : "Update Toast integration", "operationId" : "updateToastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Toast integration", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/serviceManagement/updateToastIntegrationV2" : { "post" : { "description" : "Update Toast integration", "operationId" : "updateToastIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Toast integration V2", "tags" : [ "Service Management Integrations Webservice" ] } }, "/api/integrations/storage/deleteAwsIntegration" : { "post" : { "description" : "Delete AWS S3 clip storage integration", "operationId" : "deleteAwsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete AWS integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/deleteBoxIntegration" : { "post" : { "description" : "Delete Box clip storage integration", "operationId" : "deleteBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Box integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/deleteDropboxIntegration" : { "post" : { "description" : "Delete Dropbox clip storage integration", "operationId" : "deleteDropboxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Dropbox integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/deleteGoogleIntegration" : { "post" : { "deprecated" : true, "description" : "Delete Google Drive clip storage integration", "operationId" : "deleteGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Google integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/deleteGoogleIntegrationV2" : { "post" : { "description" : "Delete Google Drive clip storage integration", "operationId" : "deleteGoogleIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Google integration V2", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/deleteOffice365Integration" : { "post" : { "description" : "Delete Office365 Sharepoint clip storage integration", "operationId" : "deleteOffice365Integration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete Office365 integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/getGoogleIntegration" : { "post" : { "description" : "Get Google Drive clip storage integration", "operationId" : "getGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Google integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/initiateDropboxOAuth" : { "post" : { "description" : "Initiate the Dropbox OAuth Process", "operationId" : "initiateDropboxOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Initiate Dropbox OAuth", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/initiateGoogleOAuth" : { "post" : { "description" : "Initiate the Google OAuth Process", "operationId" : "initiateGoogleOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Initiate Google OAuth", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/initiateOffice365OAuth" : { "post" : { "description" : "Initiate the Office365 OAuth Process", "operationId" : "initiateOffice365OAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Initiate Office365 OAuth", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/refreshGoogleAccessToken" : { "post" : { "description" : "Refresh Google access token", "operationId" : "refreshGoogleAccessToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Refresh Google access token", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/revokeGoogleDriveAccess" : { "post" : { "description" : "Revokes access to a Google Drive account", "operationId" : "revokeGoogleDriveAccess", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeGoogleDriveAccessWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke Google Drive access", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateAwsIntegration" : { "post" : { "description" : "Update AWS S3 clip storage integration", "operationId" : "updateAwsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateAwsIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update AWS integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateBoxIntegration" : { "post" : { "description" : "Update Box clip storage integration", "operationId" : "updateBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateBoxIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Box integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateDropboxIntegration" : { "post" : { "description" : "Update Dropbox clip storage integration", "operationId" : "updateDropboxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateDropboxIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Dropbox integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateGoogleIntegration" : { "post" : { "deprecated" : true, "description" : "Update Google Drive clip storage integration", "operationId" : "updateGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Google integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateGoogleIntegrationV2" : { "post" : { "description" : "Update Google Drive clip storage integration", "operationId" : "updateGoogleIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Google integration V2", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/storage/updateOffice365Integration" : { "post" : { "description" : "Update Office365 Sharepoint clip storage integration", "operationId" : "updateOffice365Integration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOffice365IntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Office365 integration", "tags" : [ "Storage Integrations Webservice" ] } }, "/api/integrations/submitApiTokenApplication" : { "post" : { "deprecated" : true, "description" : "Request an api token for organization", "operationId" : "submitApiTokenApplicationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Submit API Token Application", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/subscribeZapierWebhook" : { "post" : { "deprecated" : true, "description" : "Setup a Zapier webhook", "operationId" : "subscribeZapierWebhookDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Subscribe Zapier Webhook", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/unsubscribeZapierWebhook" : { "post" : { "deprecated" : true, "description" : "Delete a Zapier webhook", "operationId" : "unsubscribeZapierWebhookDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnsubscribeZapierWebhookWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unsubscribe Zapier Webhook", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateAmtIntegration" : { "post" : { "deprecated" : true, "description" : "Update Amt badge integration", "operationId" : "updateAmtIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update AMT Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateDeviceIntegration" : { "post" : { "deprecated" : true, "description" : "Update Device integration", "operationId" : "updateDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateDeviceIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Device Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateMattermostIntegration" : { "post" : { "deprecated" : true, "description" : "Update Mattermost alert integration", "operationId" : "updateMattermostIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Mattermost Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateNoonlightSettings" : { "post" : { "deprecated" : true, "description" : "Update Noonlight integration", "operationId" : "updateNoonlightSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateNoonlightSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Noonlight Settings", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateOpenAIIntegration" : { "post" : { "deprecated" : true, "description" : "Update OpenAI integration", "operationId" : "updateOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update OpenAI Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateWebhookIntegration" : { "post" : { "deprecated" : true, "description" : "Update outbound webhook alert integration", "operationId" : "updateWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Webhook Integration", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/updateWebhookIntegrationV2" : { "post" : { "deprecated" : true, "description" : "Update preexisting webhooks", "operationId" : "updateWebhookIntegrationV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Webhook Integration V2", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/validateToken" : { "post" : { "description" : "Verifies an API token is still active", "operationId" : "validateTokenDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Validate API Token", "tags" : [ "Integrations Webservice" ] } }, "/api/integrations/webhooks/deleteWebhookIntegration" : { "post" : { "description" : "Delete outbound webhook alert integration", "operationId" : "deleteWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete webhook integration", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/deleteWebhookIntegrationV2" : { "post" : { "description" : "Delete entire webhook integration", "operationId" : "deleteWebhookIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete webhook integration V2", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/getWebhookIntegration" : { "post" : { "description" : "Get webhook integration", "operationId" : "getWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get webhook integration", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/subscribeZapierWebhook" : { "post" : { "description" : "Setup a Zapier webhook", "operationId" : "subscribeZapierWebhook", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Subscribe Zapier webhook", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/unsubscribeZapierWebhook" : { "post" : { "description" : "Delete a Zapier webhook", "operationId" : "unsubscribeZapierWebhook", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UnsubscribeZapierWebhookWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unsubscribe Zapier webhook", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/updateWebhookIntegration" : { "post" : { "description" : "Update outbound webhook alert integration", "operationId" : "updateWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update webhook integration", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/integrations/webhooks/updateWebhookIntegrationV2" : { "post" : { "description" : "Update preexisting webhooks", "operationId" : "updateWebhookIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update webhook integration V2", "tags" : [ "Webhook Integrations Webservice" ] } }, "/api/internal/sendShipmentShippedEmail" : { "post" : { "description" : "Send shipment shipped email notification", "operationId" : "sendShipmentShippedEmail", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_SendShipmentShippedEmailWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_ShipmentEmailWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Send shipment shipped email", "tags" : [ "Internal Webservice" ] } }, "/api/keypad/claimKeypadActivationToken" : { "post" : { "description" : "Connects a keypad to Rhombus services", "operationId" : "claimKeypadActivationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Claim keypad activation token", "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, "/api/keypad/getKeypadsForLocation" : { "post" : { "description" : "Get a list of all registered keypads for a location", "operationId" : "getKeypadsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get keypads for location", "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, "/api/keypad/getKeypadsForOrg" : { "post" : { "description" : "Get a list of all registered keypads for an org", "operationId" : "getKeypadsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get keypads for organization", "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, "/api/keypad/unregisterKeypad" : { "post" : { "description" : "Unregister a keypad", "operationId" : "unregisterKeypad", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_UnregisterKeypadRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_UnregisterKeypadResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unregister keypad", "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, "/api/keypad/updateKeypad" : { "post" : { "description" : "Update keypad settings", "operationId" : "updateKeypad", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_UpdateKeypadRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Keypad_UpdateKeypadResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update keypad", "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, "/api/kiosk/updateKiosk" : { "post" : { "description" : "Update kiosk settings", "operationId" : "updateKiosk", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Kiosk_UpdateKioskSelectiveRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Kiosk_UpdateKioskResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update kiosk", "tags" : [ "Guest Management Kiosk Webservice" ] } }, "/api/license/assignACUDoorLicense" : { "post" : { "description" : "Assign ACU door license", "operationId" : "assignACUDoorLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign ACU door license", "tags" : [ "License Webservice" ] } }, "/api/license/assignAlertMonitoringLicense" : { "post" : { "description" : "Assign alert monitoring license", "operationId" : "assignAlertMonitoringLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign alert monitoring license", "tags" : [ "License Webservice" ] } }, "/api/license/assignDeviceLicense" : { "post" : { "description" : "Assign or unassign a device license.", "operationId" : "assignDeviceLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign device license", "tags" : [ "License Webservice" ] } }, "/api/license/assignGuestManagementLicense" : { "post" : { "description" : "Assign guest management license", "operationId" : "assignGuestManagementLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignGuestManagementLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignGuestManagementLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign guest management license", "tags" : [ "License Webservice" ] } }, "/api/license/assignLicense" : { "post" : { "description" : "Assign an add-on license to a device", "operationId" : "assignLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign license", "tags" : [ "License Webservice" ] } }, "/api/license/assignPaneLicense" : { "post" : { "description" : "Assign a PANE app license to a pane, or unassign it by omitting paneId", "operationId" : "assignPaneLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignPaneLicenseWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_AssignPaneLicenseWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign pane license", "tags" : [ "License Webservice" ] } }, "/api/license/claimkey/findClaimKeysByClientOrg" : { "post" : { "description" : "Find the claim keys claimed by the specified client organization, optionally filtered by state. The caller must be a partner with license administration access to the client organization. Each claim key carries the term of one purchase: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`. When filtering by state, note that a key past its `endDate` but inside its grace period has state `EXPIRED`, and a renewed key moves to `RENEWED` while its successor `RENEWAL` key carries the extended term - filtering to `CLAIMED` alone hides such coverage. To assess coverage, prefer `excludeUnclaimed: true` and compare `endDate`/`gracePeriodEndDate` per key. Client organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.", "operationId" : "findClaimKeysByClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find claim keys by client org", "tags" : [ "ClaimKey Webservice" ] } }, "/api/license/claimkey/findClaimKeysByOrg" : { "post" : { "description" : "Find the claim keys belonging to the authenticated organization, optionally filtered by state. Each claim key carries the term of one purchase, so this is how license term start/end dates are read programmatically. See `getClaimKey` for how to read the term fields. When filtering by state, note that a key past its `endDate` but inside its grace period has state `EXPIRED`, and a renewed key moves to `RENEWED` while its successor `RENEWAL` key carries the extended term - filtering to `CLAIMED` alone hides such coverage. To assess coverage, prefer `excludeUnclaimed: true` and compare `endDate`/`gracePeriodEndDate` per key. Organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.", "operationId" : "findClaimKeysByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find claim keys by org", "tags" : [ "ClaimKey Webservice" ] } }, "/api/license/claimkey/getClaimKey" : { "post" : { "description" : "Get the claim key with the specified uuid. A claim key represents one purchased term: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`.", "operationId" : "getClaimKey", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get claim key", "tags" : [ "ClaimKey Webservice" ] } }, "/api/license/findAssignedLicensesByLocation" : { "post" : { "description" : "Find all licenses assigned to a location", "operationId" : "findAssignedLicensesByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_FindAssignedLicensesByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_FindAssignedLicensesByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find assigned licenses by location", "tags" : [ "License Webservice" ] } }, "/api/license/getACUDoorLicenses" : { "post" : { "description" : "Get list of access controlled door licenses licenses available in organization", "operationId" : "getACUDoorLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get ACU door licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getACUDoorLicensesForClientOrg" : { "post" : { "description" : "Get list of access controlled door licenses licenses available for a client organization", "operationId" : "getACUDoorLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get ACU door licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/license/getAlertMonitoringLicenses" : { "post" : { "description" : "Get list of alert monitoring licenses available in organization", "operationId" : "getAlertMonitoringLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get alert monitoring licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getAlertMonitoringLicensesForClientOrg" : { "post" : { "description" : "Get list of alert monitoring licenses available for a client organization", "operationId" : "getAlertMonitoringLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get alert monitoring licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/license/getAssignablePanes" : { "post" : { "description" : "Get the PANE apps Rhombus has made available to the organization: the panes its pane licenses can be assigned to", "operationId" : "getAssignablePanes", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAssignablePanesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetAssignablePanesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get assignable panes", "tags" : [ "License Webservice" ] } }, "/api/license/getDeviceLicenses" : { "post" : { "description" : "Get list of device licenses available in organization", "operationId" : "getDeviceLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get device licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getDeviceLicensesForClientOrg" : { "post" : { "description" : "Get list of device licenses available for a client organization", "operationId" : "getDeviceLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get device licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/license/getGuestManagementLicenses" : { "post" : { "description" : "Get list of guest management licenses available in organization", "operationId" : "getGuestManagementLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetGuestManagementLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetGuestManagementLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get guest management licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getGuestManagementLicensesForClientOrg" : { "post" : { "description" : "Get list of guest management licenses available for a client organization", "operationId" : "getGuestManagementLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetGuestManagementLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetGuestManagementLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get guest management licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/license/getLicenses" : { "post" : { "description" : "Get list of add-on licenses available in organization", "operationId" : "getLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getLicensesForClientOrg" : { "post" : { "description" : "Get a list of licenses available for a client organization", "operationId" : "getLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/license/getPaneLicenseStatus" : { "post" : { "description" : "Whether this organization is currently licensed to use a PANE app. Any member of the organization may ask; the PANE gateway asks on the visitor's behalf before serving the pane.", "operationId" : "getPaneLicenseStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicenseStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicenseStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get pane license status", "tags" : [ "License Webservice" ] } }, "/api/license/getPaneLicenses" : { "post" : { "description" : "Get the list of PANE app licenses in the organization", "operationId" : "getPaneLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicensesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicensesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get pane licenses", "tags" : [ "License Webservice" ] } }, "/api/license/getPaneLicensesForClientOrg" : { "post" : { "description" : "Get the list of PANE app licenses in a client organization", "operationId" : "getPaneLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetPaneLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get pane licenses for client org", "tags" : [ "License Webservice" ] } }, "/api/location/addLocationLabel" : { "post" : { "description" : "Add a label to a location", "operationId" : "addLocationLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_AddLocationLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_AddLocationLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Add location label", "tags" : [ "Location Webservice" ] } }, "/api/location/createLocation" : { "post" : { "description" : "Create a location", "operationId" : "createlocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_CreateLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_CreateLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create location", "tags" : [ "Location Webservice" ] } }, "/api/location/deleteLocation" : { "post" : { "description" : "Remove a location", "operationId" : "deleteLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_DeleteLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_DeleteLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete location", "tags" : [ "Location Webservice" ] } }, "/api/location/geoCode" : { "post" : { "description" : "Get the latitude and longitude of an address", "operationId" : "geoCode", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GeoCodeWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GeoCodeWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Geocode address", "tags" : [ "Location Webservice" ] } }, "/api/location/getFloorPlanWalls" : { "post" : { "description" : "Get the walls detected in a floor plan image", "operationId" : "getFloorPlanWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetFloorPlanWallsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetFloorPlanWallsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get floor plan walls", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocation" : { "post" : { "description" : "Get location by id", "operationId" : "getLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get location", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocationLabelsForOrg" : { "post" : { "description" : "Get all location labels for an organization", "operationId" : "getLocationLabelsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get location labels for org", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocations" : { "post" : { "description" : "Get list of locations in organization", "operationId" : "getLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get locations", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocationsAssociatedToLocationLabelsByOrg" : { "post" : { "description" : "Get all locations associated to location labels for an organization", "operationId" : "getLocationsAssociatedToLocationLabelsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get locations by labels", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocationsByGeo" : { "post" : { "description" : "Get list of locations given latitude and longitude", "operationId" : "getLocationsByGeo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsByGeoRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsByGeoResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get locations by geo", "tags" : [ "Location Webservice" ] } }, "/api/location/getLocationsBySubLocationsHierarchyKey" : { "post" : { "description" : "Get nested locations by subLocationHierarchyKey", "operationId" : "getLocationsBySubLocationsHierarchyKey", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get locations by hierarchy key", "tags" : [ "Location Webservice" ] } }, "/api/location/refreshFloorPlanWalls" : { "post" : { "description" : "Re-detect and store the walls of a floor plan image", "operationId" : "refreshFloorPlanWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_RefreshFloorPlanWallsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_RefreshFloorPlanWallsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Refresh floor plan walls", "tags" : [ "Location Webservice" ] } }, "/api/location/removeLocationLabel" : { "post" : { "description" : "Remove a label from a location", "operationId" : "removeLocationLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove location label", "tags" : [ "Location Webservice" ] } }, "/api/location/selectiveUpdateLocation" : { "post" : { "description" : "Selectively update a location", "operationId" : "selectiveUpdateLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Selective update location", "tags" : [ "Location Webservice" ] } }, "/api/location/updateLocation" : { "post" : { "description" : "Update a location **NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation", "operationId" : "updateLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_UpdateLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Location_UpdateLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update location", "tags" : [ "Location Webservice" ] } }, "/api/logistics/getActiveRMAs" : { "post" : { "description" : "Get device uuids for active RMAs", "operationId" : "getActiveRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_GetActiveRMAsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_GetActiveRMAsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get device uuids for active RMAs", "tags" : [ "Logistics Webservice" ] } }, "/api/logistics/getRMAs" : { "post" : { "description" : "Get RMAs", "operationId" : "getRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Logistics_GetRMAsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Logistics_GetRMAsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get RMAs", "tags" : [ "Logistics Webservice" ] } }, "/api/logistics/getShipments" : { "post" : { "description" : "Get shipments", "operationId" : "getShipments", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Logistics_GetShipmentsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Logistics_GetShipmentsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get shipments", "tags" : [ "Logistics Webservice" ] } }, "/api/logistics/getWarrantyApprovedRMAs" : { "post" : { "description" : "Get warranty approved RMAs", "operationId" : "getWarrantyApprovedRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get warranty approved RMAs", "tags" : [ "Logistics Webservice" ] } }, "/api/mediadevice/getBulkMediaDeviceDetails" : { "post" : { "description" : "Get media information of any video-supporting media device", "operationId" : "getBulkMediaDeviceDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get bulk media device details", "tags" : [ "Media Device Webservice" ] } }, "/api/oauth/authorize" : { "get" : { "description" : "User authorizes to share permission and ac settings, receives temporary authorization code", "operationId" : "authorize", "parameters" : [ { "in" : "query", "name" : "clientId", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "redirectUri", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "responseType", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "state", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "consentGiven", "schema" : { "type" : "boolean", "nullable" : true } }, { "in" : "query", "name" : "codeChallenge", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "client_id", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "redirect_uri", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "response_type", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "consent_given", "schema" : { "type" : "boolean", "nullable" : true } }, { "in" : "query", "name" : "code_challenge", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "code_challenge_method", "schema" : { "type" : "string", "nullable" : true } }, { "in" : "query", "name" : "resource", "schema" : { "type" : "string", "nullable" : true } }, { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Authorize OAuth application", "tags" : [ "OAuth Webservice" ] } }, "/api/oauth/deleteApplication" : { "post" : { "description" : "Delete application", "operationId" : "deleteApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete OAuth application", "tags" : [ "OAuth Webservice" ] } }, "/api/oauth/getAllApplicationsForOrg" : { "post" : { "description" : "Get all applications for org", "operationId" : "getAllApplicationsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get all applications for organization", "tags" : [ "OAuth Webservice" ] } }, "/api/oauth/getApplicationByClientId" : { "post" : { "description" : "Get application by clientId", "operationId" : "getApplicationByClientId", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get application by client ID", "tags" : [ "OAuth Webservice" ] } }, "/api/oauth/submitApplication" : { "post" : { "description" : "Application for client_id and client_secret", "operationId" : "submitApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Submit OAuth application", "tags" : [ "OAuth Webservice" ] } }, "/api/oauth/updateApplication" : { "post" : { "description" : "Update application", "operationId" : "updateApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update OAuth application", "tags" : [ "OAuth Webservice" ] } }, "/api/occupancy/getMinimalOccupancySensorStateList" : { "post" : { "description" : "Get basic state information about all proximity tags in organization", "operationId" : "getMinimalOccupancySensorStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal occupancy sensor state list", "tags" : [ "Occupancy Webservice" ] } }, "/api/occupancy/getOccupancyEventsForSensor" : { "post" : { "description" : "Get recent events for specified proximity tag", "operationId" : "getOccupancyEventsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get occupancy events for sensor", "tags" : [ "Occupancy Webservice" ] } }, "/api/occupancy/getOccupancyPresenceWindows" : { "post" : { "description" : "Get stored video information for sensor", "operationId" : "getOccupancyPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get occupancy presence windows", "tags" : [ "Occupancy Webservice" ] } }, "/api/occupancy/updateDetails" : { "post" : { "description" : "Update the details of an occupancy sensor", "operationId" : "updateOccupancySensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update occupancy sensor details", "tags" : [ "Occupancy Webservice" ] } }, "/api/org/claimActivationToken" : { "post" : { "description" : "Claim activation token for organization", "operationId" : "claimActivationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Claim activation token", "tags" : [ "Org Webservice" ] } }, "/api/org/claimShipmentRegistrationToken" : { "post" : { "description" : "Claim shipment registration token for an organization", "operationId" : "claimShipmentRegistrationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Claim shipment registration token", "tags" : [ "Org Webservice" ] } }, "/api/org/createOrUpdateHealthNotificationRule" : { "post" : { "description" : "Create or update a time/size-based health notification rule. Omit ruleUuid to create a new rule", "operationId" : "createOrUpdateHealthNotificationRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreateOrUpdateHealthNotificationRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreateOrUpdateHealthNotificationRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create or update health notification rule", "tags" : [ "Org Webservice" ] } }, "/api/org/createPendingRegistration" : { "post" : { "description" : "Create a pending registration. Registration will be completed when the hardware establishes connectivity", "operationId" : "createPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create pending registration", "tags" : [ "Org Webservice" ] } }, "/api/org/deleteCloudArchivingConfig" : { "post" : { "description" : "Delete scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", "operationId" : "deleteCloudArchivingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete cloud archiving config", "tags" : [ "Org Webservice" ] } }, "/api/org/deleteHealthNotificationRule" : { "post" : { "description" : "Delete a time/size-based health notification rule", "operationId" : "deleteHealthNotificationRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteHealthNotificationRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteHealthNotificationRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete health notification rule", "tags" : [ "Org Webservice" ] } }, "/api/org/deleteKeypadLogo" : { "post" : { "description" : "Delete keypad logo.", "operationId" : "deleteKeypadLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete keypad logo", "tags" : [ "Org Webservice" ] } }, "/api/org/deleteRhombusKeyLogo" : { "post" : { "description" : "Delete rhombus key logo.", "operationId" : "deleteRhombusKeyLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rhombus key logo", "tags" : [ "Org Webservice" ] } }, "/api/org/findAllHardwareWithPendingRegistration" : { "post" : { "description" : "Find all hardware for which a pending registrations exists", "operationId" : "findAllHardwareWithPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all hardware with pending registration", "tags" : [ "Org Webservice" ] } }, "/api/org/findHardwareAvailableForPendingRegistration" : { "post" : { "description" : "Find hardware for which pending registrations can be created", "operationId" : "findHardwareAvailableForPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find hardware available for pending registration", "tags" : [ "Org Webservice" ] } }, "/api/org/findIfTeamNameAvailable" : { "post" : { "description" : "Get organization team name if it is available", "operationId" : "findIfTeamNameAvailable", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find if team name available", "tags" : [ "Org Webservice" ] } }, "/api/org/findSCIMSettingsForOrg" : { "post" : { "description" : "Get SCIM configuration for organization", "operationId" : "findSCIMSettingsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find SCIM settings for organization", "tags" : [ "Org Webservice" ] } }, "/api/org/generateFederatedSessionToken" : { "post" : { "description" : "Generate a federated session token login for organization", "operationId" : "generateFederatedSessionToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate federated session token", "tags" : [ "Org Webservice" ] } }, "/api/org/getClientOrg" : { "post" : { "description" : "Get details about the client organization", "operationId" : "getClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get client organization details", "tags" : [ "Org Webservice" ] } }, "/api/org/getCloudArchivingConfigs" : { "post" : { "description" : "Get scoped cloud archiving configs. Note that the priority of scoping is Org > Location > Device", "operationId" : "getCloudArchivingConfigs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get cloud archiving configs", "tags" : [ "Org Webservice" ] } }, "/api/org/getFeatures" : { "post" : { "description" : "Get organization wide features", "operationId" : "getFeatures", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetFeaturesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetFeaturesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization features", "tags" : [ "Org Webservice" ] } }, "/api/org/getHealthNotificationRules" : { "post" : { "description" : "Get all time/size-based health notification rules for the organization", "operationId" : "getHealthNotificationRules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetHealthNotificationRulesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetHealthNotificationRulesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get health notification rules", "tags" : [ "Org Webservice" ] } }, "/api/org/getOrg" : { "post" : { "deprecated" : true, "description" : "Get details about organization", "operationId" : "getOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization details", "tags" : [ "Org Webservice" ] } }, "/api/org/getOrgIntegrations" : { "post" : { "deprecated" : true, "description" : "Use endpoints in Integrations Webservice instead", "operationId" : "DEPRECATED_getOrgIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization integrations", "tags" : [ "Org Webservice" ] } }, "/api/org/getOrgNotificationTemplate" : { "post" : { "deprecated" : true, "description" : "This endpoint is no longer in use. Please use getOrgNotificationTemplateV2 instead.", "operationId" : "getOrgNotificationTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization notification template", "tags" : [ "Org Webservice" ] } }, "/api/org/getOrgNotificationTemplateV2" : { "post" : { "description" : "Get organization's default notification schedule template", "operationId" : "getOrgNotificationTemplateV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization notification template V2", "tags" : [ "Org Webservice" ] } }, "/api/org/getOrgV2" : { "post" : { "description" : "Get details about organization", "operationId" : "getOrgV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetOrgV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get organization details V2", "tags" : [ "Org Webservice" ] } }, "/api/org/getSAMLSettings" : { "post" : { "deprecated" : true, "description" : "Deprecated. Use getSAMLSettingsV2", "operationId" : "getSAMLSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get SAML settings", "tags" : [ "Org Webservice" ] } }, "/api/org/getSAMLSettingsV2" : { "post" : { "description" : "Get details about organization", "operationId" : "getSAMLSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get SAML settings V2", "tags" : [ "Org Webservice" ] } }, "/api/org/getScimDisplayInfo" : { "post" : { "description" : "Get SCIM display info for organization", "operationId" : "getScimDisplayInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetScimDisplayInfoResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get SCIM display info", "tags" : [ "Org Webservice" ] } }, "/api/org/getTemporaryOrgToken" : { "post" : { "description" : "Generate a temporary org token for use in OAuth flows", "operationId" : "getTemporaryOrgToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_GetTemporaryOrgTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetTemporaryOrgTokenResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get temporary org token", "tags" : [ "Org Webservice" ] } }, "/api/org/peekShipmentRegistrationToken" : { "post" : { "description" : "Peek at a shipping registration token for an organization", "operationId" : "peekShipmentRegistrationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Peek shipment registration token", "tags" : [ "Org Webservice" ] } }, "/api/org/removePendingRegistration" : { "post" : { "description" : "Remove a pending registration", "operationId" : "removePendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_RemovePendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_RemovePendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove pending registration", "tags" : [ "Org Webservice" ] } }, "/api/org/revokeSCIMAccessForOrg" : { "post" : { "description" : "Revoke SCIM access for organization", "operationId" : "revokeSCIMAccessForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke SCIM access for organization", "tags" : [ "Org Webservice" ] } }, "/api/org/setupSCIMAccessForOrg" : { "post" : { "description" : "Initially configure SCIM access for organization", "operationId" : "setupSCIMAccessForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Setup SCIM access for organization", "tags" : [ "Org Webservice" ] } }, "/api/org/updateAiTrainingSettings" : { "post" : { "description" : "Update organization AI training settings", "operationId" : "updateAiTrainingSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update AI training settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateCloudArchivingConfig" : { "post" : { "description" : "Update scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", "operationId" : "updateCloudArchivingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update cloud archiving config", "tags" : [ "Org Webservice" ] } }, "/api/org/updateDataRetentionSettings" : { "post" : { "description" : "Update org-level retention (in days) for face events and license plate events, covering both the event metadata and the associated image data. Face values must be between 1 and 730 days; license plate values between 1 and 365 days (orgs grandfathered on the legacy 2-year value may resend it unchanged, but cannot return to it once changed). A null value resets that data class to the platform default.", "operationId" : "updateDataRetentionSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateDataRetentionSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateDataRetentionSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization data retention settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateFirmwareSettings" : { "post" : { "description" : "Update organization firmware schedule settings", "operationId" : "updateFirmwareSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update firmware settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateGeneralSettings" : { "post" : { "description" : "Update organization General settings", "operationId" : "updateGeneralSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update general settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateLoginIpAllowlist" : { "post" : { "description" : "Update the org-wide login IP allowlist that users flagged with restrictToAllowedLoginIps are limited to", "operationId" : "updateLoginIpAllowlist", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateLoginIpAllowlistWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateLoginIpAllowlistWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update login IP allowlist", "tags" : [ "Org Webservice" ] } }, "/api/org/updateMFASettings" : { "post" : { "description" : "Update organization MFA settings", "operationId" : "updateMFASettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update MFA settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrg" : { "post" : { "deprecated" : true, "description" : "Update organization details", "operationId" : "updateOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization details", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrgAudioAnalysisPolicy" : { "post" : { "description" : "Update organization AI audio analysis policy", "operationId" : "updateOrgAudioAnalysisPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization AI audio analysis policy", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrgAudioRecordingPolicy" : { "post" : { "description" : "Update organization audio recording policy", "operationId" : "updateOrgAudioRecordingPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization audio recording policy", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrgLLMUsagePolicy" : { "post" : { "description" : "Update organization's LLM usage opt-in policy", "operationId" : "updateOrgLLMUsagePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization's LLM usage opt-in policy", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrgNotificationTemplate" : { "post" : { "deprecated" : true, "description" : "This endpoint is no longer in use. Please use updateOrgNotificationTemplateV2 instead.", "operationId" : "updateOrgNotificationTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization notification template", "tags" : [ "Org Webservice" ] } }, "/api/org/updateOrgNotificationTemplateV2" : { "post" : { "description" : "Update default notification schedule template for newly created Users in Org", "operationId" : "updateOrgNotificationTemplateV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update organization notification template V2", "tags" : [ "Org Webservice" ] } }, "/api/org/updatePaneLinks" : { "post" : { "description" : "Replace the set of PANE proof-of-concept apps surfaced in this organization's console navigation. Send the complete set; an empty list removes them all.", "operationId" : "updatePaneLinks", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdatePaneLinksWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdatePaneLinksWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update the PANE apps this org links", "tags" : [ "Org Webservice" ] } }, "/api/org/updatePendingRegistration" : { "post" : { "description" : "Update pending registration for hardware", "operationId" : "updatePendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update pending registration", "tags" : [ "Org Webservice" ] } }, "/api/org/updateSAMLSettings" : { "post" : { "deprecated" : true, "description" : "Deprecated. Use updateSAMLSettingsV2", "operationId" : "updateSAMLSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update SAML settings", "tags" : [ "Org Webservice" ] } }, "/api/org/updateSAMLSettingsV2" : { "post" : { "description" : "Update organization SAML settings", "operationId" : "updateSAMLSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update SAML settings V2", "tags" : [ "Org Webservice" ] } }, "/api/org/updateSCIMSettingsForOrg" : { "post" : { "description" : "Update SCIM configuration for organization", "operationId" : "updateSCIMSettingsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update SCIM settings for organization", "tags" : [ "Org Webservice" ] } }, "/api/partner/createPartnerClient" : { "post" : { "description" : "Create a client account", "operationId" : "createPartnerClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create partner client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/customizeClient" : { "post" : { "description" : "Customize a client account", "operationId" : "customizeClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CustomizeClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CustomizeClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Customize client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/customizeClientDevice" : { "post" : { "description" : "Customize a client device", "operationId" : "customizeClientDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Customize client device", "tags" : [ "Partner Webservice" ] } }, "/api/partner/deactivateClient" : { "post" : { "description" : "MSP only. Soft-deletes a managed client org after a typed name confirmation. Refused while devices are registered or MSP-owned licenses are assigned; unassigned pooled licenses are reclaimed first; every session in the client org is ended; the MSP's authority row is kept so the org can be restored by Rhombus.", "operationId" : "deactivateClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_DeactivateClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_DeactivateClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Deactivate managed client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/deleteClient" : { "post" : { "description" : "Delete a client account", "operationId" : "deletePartnerClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_DeleteClientWebRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_DeleteClientWebResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete partner client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getApiTokenApplications" : { "post" : { "deprecated" : true, "description" : "Get details of all open api token requests for organization", "operationId" : "partner_getApiTokenApplications", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get API token applications", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getApiTokens" : { "post" : { "description" : "Get list of all api tokens for a partner", "operationId" : "partner_getApiTokens", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetPartnerApiTokensWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get API tokens", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClaimKeysForPartnerOrg" : { "post" : { "description" : "Get the claim keys associated with the authenticated partner organization", "operationId" : "getClaimKeysForPartnerOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get claim keys for partner organization", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClientDevices" : { "post" : { "description" : "Retrieve a list of devices for a specific client.", "operationId" : "getClientDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetClientDevicesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetClientDevicesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get client devices", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClientStatusMap" : { "post" : { "description" : "Get a map of all client accounts to device and location info", "operationId" : "getPartnerClientsStatusMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get client status map", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClientSummaryInfo" : { "post" : { "description" : "Get information about a client", "operationId" : "getClientSummaryInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get client summary info", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClients" : { "post" : { "description" : "Get a list of all client accounts", "operationId" : "getPartnerClients", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get partner clients", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getClientsV2" : { "post" : { "description" : "Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.", "operationId" : "getPartnerClientsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get partner clients V2", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getDeviceLicensesForOrg" : { "post" : { "deprecated" : true, "description" : "Get a list of licenses available for a client organization", "operationId" : "getDeviceLicensesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get device licenses for organization", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getLicensesForOrg" : { "post" : { "deprecated" : true, "description" : "Get a list of licenses available for a client organization", "operationId" : "getLicensesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get licenses for organization", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getListOfAllClientDevices" : { "post" : { "description" : "Retrieve list of all devices registered across all clients", "operationId" : "getListOfAllClientDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of all client devices", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getListOfAvailableHardware" : { "post" : { "description" : "Retrieve a list of hardware available for remote registration. Any hardware originally registered by a Partner is available for re-registration after being removed from an active client account.", "operationId" : "getListOfControlledHardware", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get list of available hardware", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getPartnerOrgProfile" : { "post" : { "description" : "Whether the calling partner is a verified MSP (designation ACTIVE and signature valid), its designation status and the caller's partner functionalities.", "operationId" : "getPartnerOrgProfile", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetPartnerOrgProfileWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetPartnerOrgProfileWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get partner org MSP profile", "tags" : [ "Partner Webservice" ] } }, "/api/partner/getShipments" : { "post" : { "description" : "Get client shipments", "operationId" : "PartnerGetShipments", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetShipmentsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetShipmentsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get client shipments", "tags" : [ "Partner Webservice" ] } }, "/api/partner/hardware/getInventory" : { "post" : { "description" : "MSP only. Every hardware unit under the MSP's PARTNER control with the org it is currently registered in, its device, license state and whether it is bound to an access-controlled door.", "operationId" : "getHardwareInventory", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetHardwareInventoryWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetHardwareInventoryWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get MSP hardware inventory", "tags" : [ "Partner Webservice" ] } }, "/api/partner/hardware/moveToClient" : { "post" : { "description" : "MSP only. Moves controlled devices from one managed client org to another (soft-delete in the source, pending registration in the target). Door-bound DC20 / DR40 / DR20 units are refused until unbound. Optionally moves an MSP-owned device license along. Per-serial results.", "operationId" : "moveHardwareToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_MoveHardwareToClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_MoveHardwareToClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Move controlled hardware to another managed client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/license/assignToClient" : { "post" : { "description" : "MSP only. Moves N unassigned pool licenses of a product to a managed client org. Term dates are unchanged. Idempotent by requestId.", "operationId" : "assignLicensesToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_AssignLicensesToClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_AssignLicensesToClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign pool licenses to a managed client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/license/claimToPool" : { "post" : { "description" : "MSP only. Claims a key into the MSP's own org with the MSP recorded as owner, so the licenses can later be assigned to managed clients.", "operationId" : "claimLicensesToPool", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_ClaimLicensesToPoolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_ClaimLicensesToPoolWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Claim licenses into the MSP pool", "tags" : [ "Partner Webservice" ] } }, "/api/partner/license/getClaimKeyByCode" : { "post" : { "description" : "MSP only. Looks up a claim key by code before claiming it into the pool. Same visibility rule as the customer-console getClaimKeyByCode: an unclaimed key, or one already claimed by the calling MSP org; a key claimed by any other org is refused.", "operationId" : "getPoolClaimKeyByCode", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyByCodeWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyByCodeWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Preview a claim key for the MSP pool", "tags" : [ "Partner Webservice" ] } }, "/api/partner/license/getPool" : { "post" : { "description" : "MSP only. Per product: licenses owned by the MSP, how many sit unassigned in the pool, how many each managed client holds, and unclaimed keys.", "operationId" : "getLicensePool", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetLicensePoolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_GetLicensePoolWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get MSP license pool", "tags" : [ "Partner Webservice" ] } }, "/api/partner/license/reclaimFromClient" : { "post" : { "description" : "MSP only. Moves MSP-owned licenses held by a managed client back to the pool, optionally unassigning them from devices first. Idempotent by requestId.", "operationId" : "reclaimLicensesFromClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_ReclaimLicensesFromClientWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_ReclaimLicensesFromClientWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reclaim pool licenses from a managed client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/reassignDeviceOrg" : { "post" : { "description" : "Reassign device(s) to a different organization. Only devices which hardware is controlled by the partner can be reassigned", "operationId" : "reassignDeviceOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reassign device organization", "tags" : [ "Partner Webservice" ] } }, "/api/partner/registerCameraToClient" : { "post" : { "description" : "Register a controlled camera to a client", "operationId" : "registerCameraToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Register camera to client", "tags" : [ "Partner Webservice" ] } }, "/api/partner/registerDeal" : { "post" : { "description" : "Register a deal", "operationId" : "registerDeal", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_RegisterDealWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_RegisterDealWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Register deal", "tags" : [ "Partner Webservice" ] } }, "/api/partner/revokeApiToken" : { "post" : { "description" : "Remove an api token from organization. Note: this is irreversible", "operationId" : "partner_revokeApiToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Revoke API token", "tags" : [ "Partner Webservice" ] } }, "/api/partner/updateManagedClientPolicy" : { "post" : { "description" : "MSP only. Sets the per-client policy on a managed org, currently whether client-org users may assign the Super Admin role.", "operationId" : "updateManagedClientPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_UpdateManagedClientPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_msp_UpdateManagedClientPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update managed client policy", "tags" : [ "Partner Webservice" ] } }, "/api/partner/updateSendLicenseExpirationEmail" : { "post" : { "description" : "Update send license expiration email feature flag by org", "operationId" : "updateManuallySendLicenseExpirationEmail", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update send license expiration email", "tags" : [ "Partner Webservice" ] } }, "/api/permission/createPartnerPermissionGroup" : { "post" : { "description" : "Create a permission group", "operationId" : "createPartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create partner permission group", "tags" : [ "Permission Webservice" ] } }, "/api/permission/createPermissionGroup" : { "post" : { "description" : "Create a permission group", "operationId" : "createPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create permission group", "tags" : [ "Permission Webservice" ] } }, "/api/permission/deletePartnerPermissionGroup" : { "post" : { "description" : "Delete a permission group", "operationId" : "deletePartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete partner permission group", "tags" : [ "Permission Webservice" ] } }, "/api/permission/deletePermissionGroup" : { "post" : { "description" : "Delete a permission group", "operationId" : "deletePermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete permission group", "tags" : [ "Permission Webservice" ] } }, "/api/permission/getPartnerPermissionGroups" : { "post" : { "description" : "Get partner permission groups for the organization", "operationId" : "getPartnerPermissionGroups", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get partner permission groups", "tags" : [ "Permission Webservice" ] } }, "/api/permission/getPermissionGroups" : { "post" : { "description" : "Get details about all permission groups in organization", "operationId" : "getPermissionGroups", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get permission groups", "tags" : [ "Permission Webservice" ] } }, "/api/permission/getPermissionsForCurrentPartner" : { "post" : { "description" : "Get permissions for the current partner user", "operationId" : "getPermissionsForCurrentPartner", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get permissions for current partner", "tags" : [ "Permission Webservice" ] } }, "/api/permission/getPermissionsForCurrentUser" : { "post" : { "description" : "Get device and functionality permissions for user or API token", "operationId" : "getPermissionsForCurrentUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get permissions for current user", "tags" : [ "Permission Webservice" ] } }, "/api/permission/updatePartnerPermissionGroup" : { "post" : { "description" : "Update a partner permission group", "operationId" : "updatePartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update partner permission group", "tags" : [ "Permission Webservice" ] } }, "/api/permission/updatePermissionGroup" : { "post" : { "description" : "Update a permission group", "operationId" : "updatePermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update permission group", "tags" : [ "Permission Webservice" ] } }, "/api/policy/createAccessControlledDoorPolicy" : { "post" : { "description" : "Create a policy to be assigned to a access controlled door", "operationId" : "createAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create access controlled door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createAudioPolicy" : { "post" : { "description" : "Create a policy to be assigned to audio gateways", "operationId" : "createAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create audio policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createCameraPolicy" : { "post" : { "description" : "Create a policy to be assigned to cameras", "operationId" : "createCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create camera policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createClimatePolicy" : { "post" : { "description" : "Create a policy to be assigned to a climate sensor", "operationId" : "createClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create climate policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createDoorPolicy" : { "post" : { "description" : "Create a policy to be assigned to a door sensor", "operationId" : "createDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createOccupancyPolicy" : { "post" : { "description" : "Create a policy to be assigned to a occupancy sensor", "operationId" : "createOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create occupancy policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createPolicyAddendumForLocation" : { "post" : { "description" : "Create policy addendum for location", "operationId" : "createPolicyAddendumForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create policy addendum for location", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createPolicyAddendumsForDevices" : { "post" : { "description" : "Create policy addendums for devices", "operationId" : "createPolicyAddendumsForDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create policy addendums for devices", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createProximityPolicy" : { "post" : { "description" : "Create a policy to be assigned to an asset tag", "operationId" : "createProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create proximity policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createSchedule" : { "post" : { "description" : "Create a schedule to be used for policy creation", "operationId" : "createSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create schedule", "tags" : [ "Policy Webservice" ] } }, "/api/policy/createVideoIntercomPolicy" : { "post" : { "description" : "Create a video intercom policy", "operationId" : "createVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create video intercom policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteAccessControlledDoorPolicy" : { "post" : { "description" : "Delete an access controlled door policy", "operationId" : "deleteAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete access controlled door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteAudioPolicy" : { "post" : { "description" : "Delete a audio gateway policy", "operationId" : "deleteAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete audio policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteCameraPolicy" : { "post" : { "description" : "Delete a camera policy", "operationId" : "deleteCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete camera policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteClimatePolicy" : { "post" : { "description" : "Delete a climate policy", "operationId" : "deleteClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete climate policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteDevicePolicyAddendums" : { "post" : { "description" : "Delete a policy addendums", "operationId" : "deleteDevicePolicyAddendums", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete device policy addendums", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteDoorPolicy" : { "post" : { "description" : "Delete a door sensor policy", "operationId" : "deleteDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteLocationPolicyAddendum" : { "post" : { "description" : "Delete a policy addendums", "operationId" : "deleteLocationPolicyAddendum", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete location policy addendum", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteOccupancyPolicy" : { "post" : { "description" : "Delete an Occupancy policy", "operationId" : "deleteOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete occupancy policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deletePolicyPauseSettingForComponentComposite" : { "post" : { "description" : "Delete a policy pause setting for a component composite", "operationId" : "deletePolicyPauseSettingForComponentComposite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete policy pause setting for component composite", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deletePolicyPauseSettingForDevice" : { "post" : { "description" : "Delete a policy pause setting for a device", "operationId" : "deletePolicyPauseSettingForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete policy pause setting for device", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deletePolicyPauseSettingForLocation" : { "post" : { "description" : "Delete a policy pause setting for a location", "operationId" : "deletePolicyPauseSettingForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete policy pause setting for location", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteProximityPolicy" : { "post" : { "description" : "Delete an asset tag policy", "operationId" : "deleteProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete proximity policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteSchedule" : { "post" : { "description" : "Delete a schedule used for policy creation", "operationId" : "deleteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete schedule", "tags" : [ "Policy Webservice" ] } }, "/api/policy/deleteVideoIntercomPolicy" : { "post" : { "description" : "Delete a video intercom policy", "operationId" : "deleteVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete video intercom policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/findSchedules" : { "post" : { "description" : "Find all schedules in organization", "operationId" : "findSchedules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_FindSchedulesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_FindSchedulesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find schedules", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getAccessControlledDoorPolicies" : { "post" : { "description" : "Get details about all access controlled door policies in organization", "operationId" : "getAccessControlledDoorPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get access controlled door policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getAudioPolicies" : { "post" : { "description" : "Get details about all audio gateway policies in organization", "operationId" : "getAudioPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audio policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getCameraPolicies" : { "post" : { "description" : "Get details about all camera policies in organization", "operationId" : "getCameraPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get camera policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getClimatePolicies" : { "post" : { "description" : "Get details about all climate policies in organization", "operationId" : "getClimatePolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get climate policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getDoorPolicies" : { "post" : { "description" : "Get details about all door sensor policies in organization", "operationId" : "getDoorPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get door policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getOccupancyPolicies" : { "post" : { "description" : "Get details about all occupancy policies in organization", "operationId" : "getOccupancyPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get occupancy policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getPoliciesUsingSchedule" : { "post" : { "description" : "Get details about all climate policies in organization", "operationId" : "getPoliciesUsingSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get policies using schedule", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getPolicyAddendums" : { "post" : { "description" : "Get the current and planned policy alert addendums", "operationId" : "getPolicyAddendums", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get policy addendums", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getPolicyPauseSettings" : { "post" : { "description" : "Get the current and planned policy alert pause details", "operationId" : "getPolicyPauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get policy pause settings", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getProximityPolicies" : { "post" : { "description" : "Get details about all asset tag policies in organization", "operationId" : "getProximityPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get proximity policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getTrackPauseSettings" : { "post" : { "description" : "List active and scheduled per-track alert snoozes across devices and locations", "operationId" : "getTrackPauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetTrackPauseSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetTrackPauseSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get track pause settings", "tags" : [ "Policy Webservice" ] } }, "/api/policy/getVideoIntercomPolicies" : { "post" : { "description" : "Get details about all video intercom policies in organization", "operationId" : "getVideoIntercomPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get video intercom policies", "tags" : [ "Policy Webservice" ] } }, "/api/policy/pauseAlertPolicyForComponentComposite" : { "post" : { "description" : "Pause alert policy for component composite", "operationId" : "pauseAlertPolicyForComponentComposite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause alert policy for component composite", "tags" : [ "Policy Webservice" ] } }, "/api/policy/pauseAlertPolicyForDevice" : { "post" : { "description" : "Pause alert policy for device", "operationId" : "pauseAlertPolicyForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause alert policy for device", "tags" : [ "Policy Webservice" ] } }, "/api/policy/pauseAlertPolicyForLocation" : { "post" : { "description" : "Pause alert policy for location", "operationId" : "pauseAlertPolicyForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause alert policy for location", "tags" : [ "Policy Webservice" ] } }, "/api/policy/pauseTrackAlerts" : { "post" : { "description" : "Pause track alerts for a single reID stableTrackId on a device until duration elapses", "operationId" : "pauseTrackAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseTrackAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause track alerts for a stable track id", "tags" : [ "Policy Webservice" ] } }, "/api/policy/pauseTrackAlertsForLocation" : { "post" : { "description" : "Pause track alerts for a single reID stableTrackId across a whole location until duration elapses", "operationId" : "pauseTrackAlertsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseTrackAlertsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause track alerts for a stable track id across a location", "tags" : [ "Policy Webservice" ] } }, "/api/policy/resumeTrackAlerts" : { "post" : { "description" : "Cancel a previously set per-track alert pause", "operationId" : "resumeTrackAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseTrackAlertsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Resume track alerts for a stable track id", "tags" : [ "Policy Webservice" ] } }, "/api/policy/resumeTrackAlertsForLocation" : { "post" : { "description" : "Cancel a previously set per-track location alert pause", "operationId" : "resumeTrackAlertsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseTrackAlertsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Resume track alerts for a stable track id across a location", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateAccessControlledDoorPolicy" : { "post" : { "description" : "Update an access controlled door policy", "operationId" : "updateAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update access controlled door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateAudioPolicy" : { "post" : { "description" : "Update a audio gateway policy", "operationId" : "updateAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update audio policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateCameraPolicy" : { "post" : { "description" : "Update a camera policy", "operationId" : "updateCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update camera policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateClimatePolicy" : { "post" : { "description" : "Update a climate policy", "operationId" : "updateClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update climate policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateDoorPolicy" : { "post" : { "description" : "Update a door sensor policy", "operationId" : "updateDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update door policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateOccupancyPolicy" : { "post" : { "description" : "Update an occupancy policy", "operationId" : "updateOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update occupancy policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateProximityPolicy" : { "post" : { "description" : "Update an asset tag policy", "operationId" : "updateProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update proximity policy", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateSchedule" : { "post" : { "description" : "Update a schedule to be used for policy creation", "operationId" : "updateSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update schedule", "tags" : [ "Policy Webservice" ] } }, "/api/policy/updateVideoIntercomPolicy" : { "post" : { "description" : "Update video intercom policy", "operationId" : "updateVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update video intercom policy", "tags" : [ "Policy Webservice" ] } }, "/api/proximity/getLocomotionEventsForTag" : { "post" : { "description" : "Get locomotion events for specified proximity tag", "operationId" : "getLocomotionEventsForTag", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get locomotion events for tag", "tags" : [ "Proximity Webservice" ] } }, "/api/proximity/getMinimalProximityStateList" : { "post" : { "description" : "Get basic state information about all proximity tags in organization", "operationId" : "getMinimalProximityStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal proximity state list", "tags" : [ "Proximity Webservice" ] } }, "/api/proximity/getProximityEventsForTag" : { "post" : { "description" : "Get recent events for specified proximity tag", "operationId" : "getProximityEventsForTags", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get proximity events for tag", "tags" : [ "Proximity Webservice" ] } }, "/api/proximity/updateDetails" : { "post" : { "description" : "Update details for a proximity tag", "operationId" : "updateProximitySensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update proximity sensor details", "tags" : [ "Proximity Webservice" ] } }, "/api/rapidsos/getNearbyFeeds" : { "post" : { "description" : "Get closest 10 feeds by lat and long", "operationId" : "getNearbyFeeds", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get nearby feeds", "tags" : [ "RapidSOS Webservice" ] } }, "/api/relay/addThirdPartyCameraViaOnvif" : { "post" : { "description" : "Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials.", "operationId" : "addThirdPartyCameraViaOnvif", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Add third party camera via ONVIF", "tags" : [ "Relay Webservice" ] } }, "/api/relay/assignThirdPartyCameraToNVR" : { "post" : { "description" : "Assign a third party camera to an NVR", "operationId" : "assignThirdPartyCameraToNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign third party camera to NVR", "tags" : [ "Relay Webservice" ] } }, "/api/relay/assignThirdPartyCameraToRelayCamera" : { "post" : { "description" : "Assign a third party camera to a relay Camera", "operationId" : "assignThirdPartyCameraToRelayCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign third party camera to relay camera", "tags" : [ "Relay Webservice" ] } }, "/api/relay/assignThirdPartyMultiFacetCameraToNVR" : { "post" : { "description" : "Assign a multi-sensor third party camera to an NVR as one camera with multiple video facets (gated on the multiFacetThirdPartyCameraEnabled org flag)", "operationId" : "assignThirdPartyMultiFacetCameraToNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign multi-facet third party camera to NVR", "tags" : [ "Relay Webservice" ] } }, "/api/relay/authenticateThirdPartyCamera" : { "post" : { "description" : "Authenticate a third party camera, effectively validating the credentials specified to be used for it.", "operationId" : "authenticateThirdPartyCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Authenticate third party camera", "tags" : [ "Relay Webservice" ] } }, "/api/relay/createThirdPartyCameraPassword" : { "post" : { "description" : "Create a third party camera password", "operationId" : "createThirdPartyCameraPassword", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create third party camera password", "tags" : [ "Relay Webservice" ] } }, "/api/relay/deleteThirdPartyCameraDiscovery" : { "post" : { "description" : "Delete third party camera discovery if it has no assignments.", "operationId" : "deleteThirdPartyCameraDiscovery", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete third party camera discovery", "tags" : [ "Relay Webservice" ] } }, "/api/relay/deleteThirdPartyCameraPassword" : { "post" : { "description" : "Delete a third party camera password", "operationId" : "deleteThirdPartyCameraPassword", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete third party camera password", "tags" : [ "Relay Webservice" ] } }, "/api/relay/executeThirdPartyCameraDiscovery" : { "post" : { "description" : "Trigger a discovery of cameras on the local LANs", "operationId" : "executeThirdPartyCameraDiscovery", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Execute third party camera discovery", "tags" : [ "Relay Webservice" ] } }, "/api/relay/findDiscoveriesWithUnassignedRtspEndpoints" : { "post" : { "description" : "Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.", "operationId" : "findDiscoveriesWithUnassignedRtspEndpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find discoveries with unassigned RTSP endpoints", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getAssignedThirdPartyCameras" : { "post" : { "description" : "Get a list of the third party cameras assigned to an NVR", "operationId" : "getAssignedThirdPartyCameras", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get assigned third party cameras", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getDetails" : { "post" : { "description" : "Get hardware details of multiple NVRs", "operationId" : "getNVRDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get NVR details", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getFullNVRState" : { "post" : { "description" : "Get detailed information about state of specified NVR", "operationId" : "getFullNVRState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get full NVR state", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getMinimalNVRStateList" : { "post" : { "description" : "Get basic state information about all NVRs in organization", "operationId" : "getMinimalNVRStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal NVR state list", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getMinimalThirdPartyCameraStateList" : { "post" : { "description" : "Get basic state information about all third party cameras in the organization", "operationId" : "getMinimalThirdPartyCameraStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get minimal third party camera state list", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getRtspEndpoints" : { "post" : { "description" : "Gets rtsp endpoints for device with the specified mac address.", "operationId" : "getRtspEndpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get RTSP endpoints", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getThirdPartyCameraDiscoveryScanStatus" : { "post" : { "description" : "Returns the progress of the current/most-recent third-party camera discovery run in the org, so clients can show progress and distinguish not-started, in-progress, and complete (including complete-with-zero-cameras).", "operationId" : "getThirdPartyCameraDiscoveryScanStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get third party camera discovery scan status", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getThirdPartyCameraPasswords" : { "post" : { "description" : "Get a list of the third party camera passwords", "operationId" : "getThirdPartyCameraPasswords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get third party camera passwords", "tags" : [ "Relay Webservice" ] } }, "/api/relay/getUptimeWindows" : { "post" : { "description" : "Get uptime information for an NVR.", "operationId" : "getRelayUptimeWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get uptime information for an NVR.", "tags" : [ "Relay Webservice" ] } }, "/api/relay/manualDiscoverCamera" : { "post" : { "description" : "Manually identify a camera on the network", "operationId" : "manualDiscoverCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Manual discover camera", "tags" : [ "Relay Webservice" ] } }, "/api/relay/ptzMove" : { "post" : { "description" : "Trigger a pan, tilt, or zoom", "operationId" : "ptzMove", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_PTZMoveWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_PTZMoveWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "PTZ move", "tags" : [ "Relay Webservice" ] } }, "/api/relay/ptzStatus" : { "post" : { "description" : "Returns ptz status", "operationId" : "ptz", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_PTZStatusWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_PTZStatusWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "PTZ status", "tags" : [ "Relay Webservice" ] } }, "/api/relay/reboot" : { "post" : { "description" : "Reboot an NVR", "operationId" : "rebootNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_RebootNVRVWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_RebootNVRVWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reboot NVR", "tags" : [ "Relay Webservice" ] } }, "/api/relay/unassignThirdPartyCamera" : { "post" : { "description" : "Unassign a third party camera from an NVR", "operationId" : "unassignThirdPartyCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unassign third party camera", "tags" : [ "Relay Webservice" ] } }, "/api/relay/unregister" : { "post" : { "description" : "Remove an NVR from organization", "operationId" : "unregisterNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UnregisterNVRWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UnregisterNVRWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Unregister NVR", "tags" : [ "Relay Webservice" ] } }, "/api/relay/updateDetailsV2" : { "post" : { "description" : "Update hardware details of NVR.", "operationId" : "updateNVRDetailsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UpdateNVRWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UpdateNVRWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update NVR details V2", "tags" : [ "Relay Webservice" ] } }, "/api/relay/updateFirmware" : { "post" : { "description" : "Send command to update firmware to NVR", "operationId" : "updateNVRFirmware", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update NVR firmware", "tags" : [ "Relay Webservice" ] } }, "/api/report/getAuditFeed" : { "post" : { "description" : "Get the latest audit logs for organization", "operationId" : "getAuditFeed", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetAuditFeedWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetAuditFeedWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get audit feed", "tags" : [ "Report Webservice" ] } }, "/api/report/getBatchThresholdCrossingCountReport" : { "post" : { "description" : "Get batch threshold crossing count report", "operationId" : "getBatchThresholdCrossingCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetBatchThresholdCrossingCountReportWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get batch threshold crossing count report", "tags" : [ "Report Webservice" ] } }, "/api/report/getCountReport" : { "post" : { "deprecated" : true, "description" : "Use /getCountReportV2 instead", "operationId" : "getCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get count report", "tags" : [ "Report Webservice" ] } }, "/api/report/getCountReportV2" : { "post" : { "description" : "Get the specified count reports", "operationId" : "getCountReportV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get count report V2", "tags" : [ "Report Webservice" ] } }, "/api/report/getCountReports" : { "post" : { "description" : "Get multiple specified count reports", "operationId" : "getCountReports", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get count reports", "tags" : [ "Report Webservice" ] } }, "/api/report/getCountReportsForDevicesAtLocation" : { "post" : { "description" : "Get count reports by device for a specified location", "operationId" : "getCountReportsForDevicesAtLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportsForDevicesAtLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get count reports for devices at location", "tags" : [ "Report Webservice" ] } }, "/api/report/getCustomEventsBinaryCounts" : { "post" : { "description" : "Retrieves aggregated counts of boolean event values (true/false) produced by a selected prompt over a specified time window.\n\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns a BinaryAggregationValue with counts for true and false.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs (if available) and the bucket timestamp from BaseReportValue.\n\nNotes:\n\t•\tOnly binary/boolean prompt types are valid for this endpoint.\n", "operationId" : "getCustomEventsBinaryCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMWBinaryWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get custom events aggregation binary counts", "tags" : [ "Report Webservice" ] } }, "/api/report/getCustomEventsNumericCounts" : { "post" : { "description" : "Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window.\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns numeric aggregates derived from raw values: count, sum, min, max, average.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs indicating when min/max occurred within the bucket (if available).\n\t•\tBucket timestamps are returned as epoch ms.\n\nNotes:\n\t•\tOnly numeric prompt types are valid for this endpoint.\n", "operationId" : "getCustomEventsNumericCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMNumericWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get custom events aggregation numeric counts", "tags" : [ "Report Webservice" ] } }, "/api/report/getCustomEventsReport" : { "post" : { "description" : "Retrieves a custom events report containing raw time-series event values recorded by selected prompts and devices within the specified time window.\nThe report can be filtered by:\n\t•\tpromptUuid – The specific prompt to query.\n\t•\tdeviceFacetUuids – A set of devices to include.\n\t•\tlocationUuid – The location context for the query.\nFor example, a request may specify a promptUuid to fetch results from a certain LLM prompt, and additionally restrict results to only devices in a given locationUuid.\nThe time range (startTimeMs → endTimeMs) is required and determines the interval of events returned.\nThe response includes, per device and prompt, the raw event values (numeric or boolean as string) along with timestamps, check-condition results (if selected), and prompt type.", "operationId" : "getCustomEventsReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get custom events report", "tags" : [ "Report Webservice" ] } }, "/api/report/getDiagnosticFeed" : { "post" : { "description" : "Get the latest diagnostic logs for organization", "operationId" : "getDiagnosticFeed", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get diagnostic feed", "tags" : [ "Report Webservice" ] } }, "/api/report/getEnvoyDeliveries" : { "post" : { "description" : "Get a list of deliveries from Envoy to populate reporting logs", "operationId" : "getEnvoyDeliveries", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Envoy deliveries", "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, "/api/report/getEnvoyEmployees" : { "post" : { "description" : "Get a list of employees from Envoy", "operationId" : "getEnvoyEmployees", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Envoy employees", "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, "/api/report/getEnvoyLocations" : { "post" : { "description" : "Get list of Envoy locations", "operationId" : "getEnvoyLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Envoy locations", "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, "/api/report/getEnvoyVisitors" : { "post" : { "description" : "Get a list of visitors from Envoy to populate reporting logs", "operationId" : "getEnvoyVisitors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Envoy visitors", "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, "/api/report/getIntegrationDiagnosticEvents" : { "post" : { "description" : "Get the diagnostic logs of supported third-party devices for organization", "operationId" : "getIntegrationDiagnosticEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get integration diagnostic events", "tags" : [ "Report Webservice" ] } }, "/api/report/getLicensePlatesByDevice" : { "post" : { "description" : "Get license plate counting events for a specified camera", "operationId" : "getLicensePlatesByDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get license plates by device", "tags" : [ "Report Webservice" ] } }, "/api/report/getOccupancyCounts" : { "post" : { "description" : "Returns the estimated occupancy count for a specified room or area within a given time range. This endpoint allows you to monitor occupancy trends over time or retrieve a single count for a defined interval.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", "operationId" : "getOccupancyCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get occupancy counts", "tags" : [ "Report Webservice" ] } }, "/api/report/getOccupancyCountsV2" : { "post" : { "description" : "Returns the estimated occupancy count for a specified room or area within a given time range using person reidentification data.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", "operationId" : "getOccupancyCountsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get occupancy counts V2", "tags" : [ "Report Webservice" ] } }, "/api/report/getProximityTagLocationsByDate" : { "post" : { "description" : "Get proximity tag locations by date", "operationId" : "getProximityTagLocationsByDate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get proximity tag locations by date", "tags" : [ "Report Webservice" ] } }, "/api/report/getRunningAverage" : { "post" : { "description" : "Get the running average for the specified count report if it is available, based on recent data", "operationId" : "getRunningAverage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetRunningAverageWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetRunningAverageWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get running average", "tags" : [ "Report Webservice" ] } }, "/api/report/getSummaryCountReport" : { "post" : { "description" : "Get a summary report for a camera, location, or organization", "operationId" : "getSummaryCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get summary count report", "tags" : [ "Report Webservice" ] } }, "/api/report/getThresholdCrossingCountReport" : { "post" : { "description" : "Get threshold crossing count report for device", "operationId" : "getThresholdCrossingCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get threshold crossing count report for device", "tags" : [ "Report Webservice" ] } }, "/api/report/getThresholdCrossingCountReportForOrg" : { "post" : { "description" : "Get org wide batch threshold crossing count report", "operationId" : "getThresholdCrossingCountReportForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get org wide batch threshold crossing count report", "tags" : [ "Report Webservice" ] } }, "/api/report/getThresholdCrossingCounts" : { "post" : { "deprecated" : true, "description" : "Get the occupancy counts from threshold crossing for a group of cameras over a period of time", "operationId" : "getThresholdCrossingCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get threshold crossing counts", "tags" : [ "Report Webservice" ] } }, "/api/report/getThresholdCrossingEvents" : { "post" : { "description" : "Get the raw threshold crossing events for a group of cameras over a period of time", "operationId" : "getThresholdCrossingEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get threshold crossing events", "tags" : [ "Report Webservice" ] } }, "/api/report/getThresholdCrossingEventsForDevice" : { "post" : { "description" : "Get threshold crossing events for device", "operationId" : "getThresholdCrossingEventsForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get threshold crossing events for device", "tags" : [ "Report Webservice" ] } }, "/api/report/getToastEventsTable" : { "post" : { "description" : "Get list of Toast orders to populate events table", "operationId" : "getToastEventsTable", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Toast events table", "tags" : [ "Report Webservice" ] } }, "/api/report/getToastEventsTableAllLocations" : { "post" : { "description" : "Get list of Toast orders from all restaurants to populate events table", "operationId" : "getToastEventsTableAllLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get Toast events table all locations", "tags" : [ "Report Webservice" ] } }, "/api/report/resetRunningAverage" : { "post" : { "description" : "Reset the running average for the specified count report", "operationId" : "resetRunningAverage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_ResetRunningAverageWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report_ResetRunningAverageWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Reset running average", "tags" : [ "Report Webservice" ] } }, "/api/robot/createPatrol" : { "post" : { "description" : "Deploy a route to a robot as a patrol, with an optional deploy schedule and per-patrol waypoint actions.", "operationId" : "createPatrol", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreatePatrolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreatePatrolWSResponse" } } }, "description" : "OK" } }, "summary" : "Create a robot patrol", "tags" : [ "Robot Webservice" ] } }, "/api/robot/createRobotRoute" : { "post" : { "description" : "Create a named route for robots", "operationId" : "createRobotRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreateRobotRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreateRobotRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Create a robot route", "tags" : [ "Robot Webservice" ] } }, "/api/robot/createRobotWaypoint" : { "post" : { "description" : "Create a standalone named pose on a map, reusable across routes.", "operationId" : "createRobotWaypoint", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreateRobotWaypointWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_CreateRobotWaypointWSResponse" } } }, "description" : "OK" } }, "summary" : "Create a standalone waypoint.", "tags" : [ "Robot Webservice" ] } }, "/api/robot/delete" : { "post" : { "description" : "Remove the robot from the organization", "operationId" : "deleteRobot", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotWSResponse" } } }, "description" : "OK" } }, "summary" : "Delete robot", "tags" : [ "Robot Webservice" ] } }, "/api/robot/deletePatrol" : { "post" : { "description" : "Delete a patrol by its patrolUuid; cascades its owned rules.", "operationId" : "deletePatrol", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeletePatrolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeletePatrolWSResponse" } } }, "description" : "OK" } }, "summary" : "Delete a robot patrol", "tags" : [ "Robot Webservice" ] } }, "/api/robot/deleteRobotRoute" : { "post" : { "description" : "Delete a robot route.", "operationId" : "deleteRobotRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Delete a robot route.", "tags" : [ "Robot Webservice" ] } }, "/api/robot/deleteRobotWaypoint" : { "post" : { "description" : "Delete a waypoint.", "operationId" : "deleteRobotWaypoint", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotWaypointWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeleteRobotWaypointWSResponse" } } }, "description" : "OK" } }, "summary" : "Delete a waypoint", "tags" : [ "Robot Webservice" ] } }, "/api/robot/deploy" : { "post" : { "description" : "Deploy the robot to a mapped point at its location", "operationId" : "deployRobot", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeployRobotWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_DeployRobotWSResponse" } } }, "description" : "OK" } }, "summary" : "Deploy robot", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findMaps" : { "post" : { "description" : "Retrieve the list of available robot maps", "operationId" : "findRobotMaps", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotMapsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotMapsWSResponse" } } }, "description" : "OK" } }, "summary" : "Retrieve the list of available robot maps", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findPatrolsByRobot" : { "post" : { "description" : "List all patrols for a robot on its currently assigned map. The map is resolved server-side from the device's map assignment; if the robot has no assigned map, the result is empty.", "operationId" : "findPatrolsByRobot", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindPatrolsByRobotWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindPatrolsWSResponse" } } }, "description" : "OK" } }, "summary" : "Find a robot's patrols on its assigned map", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findPatrolsByRoute" : { "post" : { "description" : "List all patrols deployed on the provided route, each fully composed. A route can be shared by multiple robots, and a robot can have multiple patrols on the same route.", "operationId" : "findPatrolsByRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindPatrolsByRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindPatrolsWSResponse" } } }, "description" : "OK" } }, "summary" : "Find patrols by route", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findRobotEvents" : { "post" : { "description" : "Stream behavior/activity events emitted by a robot within a time range as newline-delimited JSON (one RobotEvent JSON object per line).", "operationId" : "findRobotEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/x-ndjson" : { "schema" : { "$ref" : "#/components/schemas/RobotEvent" } } }, "description" : "OK" } }, "summary" : "Find robot events", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findRobotRoutesByMap" : { "post" : { "description" : "List all routes defined for a map.", "operationId" : "findRoutesByMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotRoutesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotRoutesWSResponse" } } }, "description" : "OK" } }, "summary" : "Find routes by map", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findRobotWaypointsByMap" : { "post" : { "description" : "Find all standalone waypoints for a given map.", "operationId" : "findRobotWaypointsByMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotWaypointsByMapWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRobotWaypointsByMapWSResponse" } } }, "description" : "OK" } }, "summary" : "Find waypoints by map", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findRouteRunsByRoute" : { "post" : { "description" : "Find route runs for a route, filtered by time range.", "operationId" : "findRouteRunsByRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRouteRunsByRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindRouteRunsByRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Find route runs by route", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findWaypointRunsByRoute" : { "post" : { "description" : "Find waypoint runs for a route, filtered by time range.", "operationId" : "findWaypointRunsByRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindWaypointRunsByRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindWaypointRunsByRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Find waypoint runs by route", "tags" : [ "Robot Webservice" ] } }, "/api/robot/findWaypointRunsByRouteRun" : { "post" : { "description" : "Find all waypoint runs for a given route run.", "operationId" : "findWaypointRunsByRouteRun", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindWaypointRunsByRouteRunWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_FindWaypointRunsByRouteRunWSResponse" } } }, "description" : "OK" } }, "summary" : "Find waypoint runs by route run", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getAllMediaUris" : { "post" : { "description" : "Get the video uris of every video facet and the audio uris of every audio facet the robot has configured, so no uri is minted under a facet that cannot serve it", "operationId" : "getAllRobotMediaUris", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetAllMediaUrisWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetAllMediaUrisWSResponse" } } }, "description" : "OK" } }, "summary" : "Get media uris for every configured facet of a robot", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getConfig" : { "post" : { "description" : "Get a robot's config", "operationId" : "getRobotConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Device_config_GetConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotConfigWSResponse" } } }, "description" : "OK" } }, "summary" : "Get robot config", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getFullState" : { "post" : { "description" : "Get detailed information about state of specified robot", "operationId" : "getRobotFullState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetFullDeviceStateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotFullStateWSResponse" } } }, "description" : "OK" } }, "summary" : "Get full robot state", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getMapAssignment" : { "post" : { "description" : "A snapshot of the ancillary map data at the timeof when the map was assigned to the device.A device can only have one active assignment record. Assignment records are immutable. Only new records can be created", "operationId" : "getMapAssignment", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetMapAssignmentWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetMapAssignmentWSResponse" } } }, "description" : "OK" } }, "summary" : "Retrieve the robot's map assignment record.", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getMapFilterImage" : { "post" : { "description" : "A PGM mask of a filter the robot applies on its currently assigned map. Same dimensions as the map image.", "operationId" : "getMapFilterImage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotMapFilterImageWSRequest" } } } }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Response" } }, "image/x-portable-graymap" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" } }, "summary" : "Robot's map filter image", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getMapImage" : { "post" : { "description" : "A PGM file of the robot's currently assigned map", "operationId" : "getMapImage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotMapImageWSRequest" } } } }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Response" } }, "image/x-portable-graymap" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" } }, "summary" : "Robot's map image", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getMapMeta" : { "post" : { "description" : "Get the robot's map meta data", "operationId" : "getRobotMapMeta", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotMapMetaWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotMapMetaWSResponse" } } }, "description" : "OK" } }, "summary" : "Get the robot's map meta data.", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getMinimalStateList" : { "post" : { "description" : "Get basic state information about all robots in organization", "operationId" : "getRobotMinimalStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_GetMinimalDeviceStateListWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotMinimalStateListWSResponse" } } }, "description" : "OK" } }, "summary" : "Get minimal robot state list", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getPatrol" : { "post" : { "description" : "Fetch a patrol by its patrolUuid.", "operationId" : "getPatrol", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetPatrolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetPatrolWSResponse" } } }, "description" : "OK" } }, "summary" : "Get a robot patrol", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getRobotRoute" : { "post" : { "description" : "Retrieve a robot route by its uuid", "operationId" : "getRobotRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Retrieve a robot route by its uuid", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getRobotWaypoint" : { "post" : { "description" : "Retrieve a standalone waypoint by its UUID.", "operationId" : "getRobotWaypoint", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotWaypointWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRobotWaypointWSResponse" } } }, "description" : "OK" } }, "summary" : "Get a waypoint by UUID", "tags" : [ "Robot Webservice" ] } }, "/api/robot/getRouteRun" : { "post" : { "description" : "Retrieve a route run by its UUID.", "operationId" : "getRouteRun", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRouteRunWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_GetRouteRunWSResponse" } } }, "description" : "OK" } }, "summary" : "Get a route run by UUID", "tags" : [ "Robot Webservice" ] } }, "/api/robot/sendHome" : { "post" : { "description" : "Send the robot back to its docking/home pose", "operationId" : "sendRobotHome", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_SendHomeWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_SendHomeWSResponse" } } }, "description" : "OK" } }, "summary" : "Send robot home", "tags" : [ "Robot Webservice" ] } }, "/api/robot/updateConfig" : { "post" : { "description" : "Update a robot's config", "operationId" : "updateRobotConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotConfigWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" } } }, "description" : "OK" } }, "summary" : "Update robot config", "tags" : [ "Robot Webservice" ] } }, "/api/robot/updateDetails" : { "post" : { "description" : "Update hardware details of robot.", "operationId" : "updateRobotDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotDetailsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Common_devices_UpdateDeviceDetailsWSResponse" } } }, "description" : "OK" } }, "summary" : "Update robot details", "tags" : [ "Robot Webservice" ] } }, "/api/robot/updatePatrol" : { "post" : { "description" : "Update a patrol's name, deploy schedule, enabled flag, and/or waypoint actions. Addressed by patrolUuid.", "operationId" : "updatePatrol", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdatePatrolWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdatePatrolWSResponse" } } }, "description" : "OK" } }, "summary" : "Update a robot patrol", "tags" : [ "Robot Webservice" ] } }, "/api/robot/updateRobotRoute" : { "post" : { "description" : "Update robot routes for a map.", "operationId" : "updateRobotRoute", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotRouteWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotRouteWSResponse" } } }, "description" : "OK" } }, "summary" : "Update robot routes for a map", "tags" : [ "Robot Webservice" ] } }, "/api/robot/updateRobotWaypoint" : { "post" : { "description" : "Update the name or pose of a standalone waypoint.", "operationId" : "updateRobotWaypoint", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotWaypointWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Robot_UpdateRobotWaypointWSResponse" } } }, "description" : "OK" } }, "summary" : "Update a waypoint", "tags" : [ "Robot Webservice" ] } }, "/api/rules/createRule" : { "post" : { "description" : "Create a rule", "operationId" : "createRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_CreateRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_CreateRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create rule", "tags" : [ "Rules Webservice" ] } }, "/api/rules/deleteIncomingWebhookToken" : { "post" : { "description" : "Delete an incoming webhook trigger token so its URL no longer fires rules", "operationId" : "deleteIncomingWebhookToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteIncomingWebhookTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteIncomingWebhookTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete incoming webhook trigger token", "tags" : [ "Rules Webservice" ] } }, "/api/rules/deleteRule" : { "post" : { "description" : "Delete a rule", "operationId" : "deleteRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rule", "tags" : [ "Rules Webservice" ] } }, "/api/rules/deleteRulePauseSetting" : { "post" : { "description" : "Delete a rule pause setting", "operationId" : "deleteRulePauseSetting", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rule pause setting", "tags" : [ "Rules Webservice" ] } }, "/api/rules/generateIncomingWebhookToken" : { "post" : { "description" : "Generate a token and public URL that fires INCOMING_WEBHOOK_EVENT rule triggers when requested", "operationId" : "generateIncomingWebhookToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GenerateIncomingWebhookTokenWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GenerateIncomingWebhookTokenWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate incoming webhook trigger token", "tags" : [ "Rules Webservice" ] } }, "/api/rules/getRulePauseSettings" : { "post" : { "description" : "Get the current and planned rule pause details", "operationId" : "getRulePauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rule pause settings", "tags" : [ "Rules Webservice" ] } }, "/api/rules/getRulesFiltered" : { "post" : { "description" : "Get rules with Uuid and Type filtering", "operationId" : "getRulesFiltered", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_GetRulesFilteredWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rules filtered", "tags" : [ "Rules Webservice" ] } }, "/api/rules/getRulesForOrg" : { "post" : { "description" : "List rules for org", "operationId" : "getRulesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rules for org", "tags" : [ "Rules Webservice" ] } }, "/api/rules/pauseRule" : { "post" : { "description" : "Pause rule", "operationId" : "pauseRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_PauseRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_PauseRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Pause rule", "tags" : [ "Rules Webservice" ] } }, "/api/rules/updateRule" : { "post" : { "description" : "Update a rule", "operationId" : "updateRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_UpdateRuleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_UpdateRuleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update rule", "tags" : [ "Rules Webservice" ] } }, "/api/rulesRecords/deleteRulesEventRecord" : { "post" : { "description" : "Delete a rules event historical record", "operationId" : "deleteRulesEventRecord", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete rules event record", "tags" : [ "Rules Records Webservice" ] } }, "/api/rulesRecords/getLatestRulesEventRecords" : { "post" : { "description" : "Get N latest rules event historical records", "operationId" : "getLatestRulesEventRecords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get latest rules event records", "tags" : [ "Rules Records Webservice" ] } }, "/api/rulesRecords/getRulesEventRecords" : { "post" : { "description" : "Find rules event historical records", "operationId" : "getRulesEventRecords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get rules event records", "tags" : [ "Rules Records Webservice" ] } }, "/api/scenequery/adHocPrompt" : { "post" : { "description" : "Exectue an existing prompt, ad-hoc", "operationId" : "adHocPrompt", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Execute a prompt, ad-hoc", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/createPromptConfiguration" : { "post" : { "description" : "Create scene query configuration", "operationId" : "createPromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create prompt configuration", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/deletePromptConfiguration" : { "post" : { "description" : "Delete scene query configuration", "operationId" : "deletePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete prompt configuration", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/findPromptConfigurations" : { "post" : { "description" : "Find all scene query configurations", "operationId" : "findAllPromptConfigurations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all prompt configurations", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/getPromptConfiguration" : { "post" : { "description" : "Get scene query configuration", "operationId" : "getPromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get prompt configuration", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/optimizePromptChat" : { "post" : { "description" : "Optimize a scene query prompt through an interactive chat with Gemini", "operationId" : "optimizePromptChat", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Optimize prompt via chat", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/selectiveUpdatePromptConfiguration" : { "post" : { "description" : "Selectively update a scene query configuration", "operationId" : "selectiveUpdatePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Selective update prompt configuration", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/triggerPrompt" : { "post" : { "description" : "Trigger scene query with a custom prompt", "operationId" : "triggerPrompt", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Trigger prompt", "tags" : [ "Scene Query Webservice" ] } }, "/api/scenequery/updatePromptConfiguration" : { "post" : { "description" : "Update scene query configuration", "operationId" : "updatePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update prompt configuration", "tags" : [ "Scene Query Webservice" ] } }, "/api/schedule/createAbsoluteSchedule" : { "post" : { "description" : "Create a absolute schedule", "operationId" : "createAbsoluteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create absolute schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/createRelativeDateTimeIntervalsSchedule" : { "post" : { "description" : "Create a one-time relative datetime schedule", "operationId" : "createRelativeDateTimeIntervalsSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create relative datetime intervals schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/createRelativeSchedule" : { "post" : { "description" : "Create a realtime relative schedule", "operationId" : "createRelativeSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create relative schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/createWeeklySchedule" : { "post" : { "description" : "Create a weekly schedule", "operationId" : "createWeeklySchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create weekly schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/deleteSchedule" : { "post" : { "description" : "Delete a schedule", "operationId" : "deleteScheduleV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/findAbsoluteSchedule" : { "post" : { "description" : "Find an absolute schedule", "operationId" : "findAbsoluteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find absolute schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/findRelativeDateTimeIntervalsSchedule" : { "post" : { "description" : "Find a one-time relative datetime schedule", "operationId" : "findRelativeDateTimeIntervalsSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find relative datetime intervals schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/findRelativeSchedule" : { "post" : { "description" : "Find a relative schedule", "operationId" : "findRelativeSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find relative schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/findWeeklySchedule" : { "post" : { "description" : "Find a weekly schedule", "operationId" : "findWeeklySchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find weekly schedule", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/getScheduleData" : { "post" : { "description" : "Get weekly schedules in org with usage data", "operationId" : "getScheduleData", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetScheduleDataWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get schedule data", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/getScheduleDataV2" : { "post" : { "description" : "Get weekly schedules in org with usage data", "operationId" : "getScheduleDataV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get schedule data V2", "tags" : [ "Schedule Webservice" ] } }, "/api/schedule/getSchedules" : { "post" : { "description" : "Get schedules in org", "operationId" : "getSchedules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule_GetSchedulesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get schedules", "tags" : [ "Schedule Webservice" ] } }, "/api/search/searchLicensePlates" : { "post" : { "deprecated" : true, "description" : "Fuzzy search for license plate sightings based on a partial or full plate number. Use /vehicle/getVehicleEvents instead.", "operationId" : "searchLicensePlates", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search license plates", "tags" : [ "Search Webservice" ] } }, "/api/search/searchObjectsByColor" : { "post" : { "description" : "Search for objects by color", "operationId" : "searchObjectsByColor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search objects by color", "tags" : [ "Search Webservice" ] } }, "/api/search/searchSimilarObjectEmbeddings" : { "post" : { "description" : "Search for similar objects by embedding", "operationId" : "searchSimilarObjectEmbeddings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search similar object embeddings", "tags" : [ "Search Webservice" ] } }, "/api/search/searchSimilarObjectEmbeddingsByText" : { "post" : { "description" : "Search for similar objects by text", "operationId" : "searchSimilarObjectEmbeddingsByText", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsByTextWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Search similar object embeddings by text", "tags" : [ "Search Webservice" ] } }, "/api/sensors/getFootageSensorSeekpointsForCamera" : { "post" : { "description" : "Retrieves sensor activity seekpoints for a specific camera within a given time range. Returns footage seekpoints that correspond to sensor events detected by the camera.", "operationId" : "getSensorFootageSensorSeekpointsForCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get sensor activity seekpoints for camera", "tags" : [ "Sensor Webservice" ] } }, "/api/sensors/getFootageSensorSeekpointsForLocation" : { "post" : { "description" : "Retrieves sensor activity seekpoints for a specific location within a given time range. Returns footage seekpoints that correspond to sensor events detected at the specified location.", "operationId" : "getFootageSensorSeekpointsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get sensor activity seekpoints for location", "tags" : [ "Sensor Webservice" ] } }, "/api/sensors/getFootageSensorSeekpointsForSensor" : { "post" : { "description" : "Retrieves sensor activity seekpoints for a specific sensor within a given time range. Returns footage seekpoints that correspond to events detected by the specified sensor device.", "operationId" : "getFootageSensorSeekpointsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get sensor activity seekpoints for sensor", "tags" : [ "Sensor Webservice" ] } }, "/api/tvos/getTvOsConfig" : { "post" : { "description" : "Retrieves a specific tvOs configuration by UUID, returning the detailed settings and parameters for a particular Apple TV client.", "operationId" : "getTvOsConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get specific tvOs config", "tags" : [ "TvOs Config Webservice" ] } }, "/api/tvos/getTvOsConfigsForOrg" : { "post" : { "description" : "Retrieves all tvOs configurations for the organization, providing a list of all Apple TV client configurations and their settings.", "operationId" : "getTvOsConfigsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get tvOs configs for organization", "tags" : [ "TvOs Config Webservice" ] } }, "/api/tvos/updateTvOsConfig" : { "post" : { "description" : "Updates the configuration for a tvOs client, allowing modification of settings and parameters for Apple TV applications.", "operationId" : "updateTvOsConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update tvOs config", "tags" : [ "TvOs Config Webservice" ] } }, "/api/upload/badgeTemplate/images" : { "post" : { "description" : "Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.", "operationId" : "uploadBadgeTemplateImages", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload badge template images", "tags" : [ "Upload Webservice" ] } }, "/api/upload/bulkUploadUserProfilePhotos" : { "post" : { "description" : "Uploads multiple user profile pictures in a single request, supporting up to 100 photos with automatic user matching based on filename or metadata. Each photo must be <= 5MB.", "operationId" : "bulkUploadUserProfilePhotos", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Bulk upload user profile pictures", "tags" : [ "Upload Webservice" ] } }, "/api/upload/companyLogo" : { "post" : { "description" : "Uploads a company logo image, supporting various formats including JPEG, PNG, BMP, GIF, WebP, and PSD, and updates the organization's logo URL.", "operationId" : "uploadCompanyLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload company logo", "tags" : [ "Upload Webservice" ] } }, "/api/upload/floorplan" : { "post" : { "description" : "Uploads a new floorplan image for a location, supporting multiple formats including JPEG, PNG, PDF, WebP, and SVG with automatic conversion to JPEG for SVG files.", "operationId" : "uploadNewFloorPlan", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload new floorplan for location", "tags" : [ "Upload Webservice" ] } }, "/api/upload/guestManagement/document" : { "post" : { "description" : "Uploads a PDF or DOCX document for guest management (e.g. for e-signature via SignatureAPI), storing it in S3 and recording it on the org's guest management settings.", "operationId" : "uploadGuestManagementDocument", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload guest management document", "tags" : [ "Upload Webservice" ] } }, "/api/upload/guestManagement/signedDocuments" : { "post" : { "description" : "Stores one or more completed, signed PDFs against the visit named by 'inviteUuid' and records them on that visit. This is the in-house counterpart to the signing provider's completion webhook: the caller already holds the finished document and hands us the bytes. The visit is required - a signed document with nothing to attach it to is unreachable afterwards. Send one 'inviteUuid' part and a repeated 'file' part per document, optionally with a matching repeated 'name' part to label each one.", "operationId" : "uploadGuestManagementSignedDocuments", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "Created" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload signed guest management documents for a visit", "tags" : [ "Upload Webservice" ] } }, "/api/upload/keypadLogo" : { "post" : { "description" : "Uploads a logo image for keypad devices, generating a unique UUID and storing the image with proper metadata and organization association.", "operationId" : "uploadKeypadLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload keypad logo", "tags" : [ "Upload Webservice" ] } }, "/api/upload/rhombusKeyLogo" : { "post" : { "description" : "Uploads a logo image for Rhombus key devices, generating a unique UUID and storing the image with proper metadata and organization association.", "operationId" : "uploadRhombusKeyLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/FormDataMultiPart" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Upload Rhombus key logo", "tags" : [ "Upload Webservice" ] } }, "/api/user/assignEmailToUser" : { "post" : { "description" : "Assign a user to an email as long as the user is not currently assigned to one, with validation to prevent duplicate email associations.", "operationId" : "assignEmailToUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_AssignEmailToUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_AssignEmailToUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Assign email to user", "tags" : [ "User Webservice" ] } }, "/api/user/createUser" : { "post" : { "description" : "Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.", "operationId" : "createUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_CreateUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_CreateUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create user for organization", "tags" : [ "User Webservice" ] } }, "/api/user/deleteUser" : { "post" : { "description" : "Delete a user from the organization with proper validation to prevent deletion of the last super admin and current user.", "operationId" : "deleteUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_DeleteUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_DeleteUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete user", "tags" : [ "User Webservice" ] } }, "/api/user/getPartnerUsersInOrg" : { "post" : { "description" : "Get list of all partners in organization with partner-specific user details and permissions.", "operationId" : "getPartnerUsersInOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get partner users in organization", "tags" : [ "User Webservice" ] } }, "/api/user/getUsersInOrg" : { "post" : { "description" : "Get list of all users in organization with complete user details, permissions, notification settings, and partner information.", "operationId" : "getUsersInOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_GetUsersInOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_GetUsersInOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get users in organization", "tags" : [ "User Webservice" ] } }, "/api/user/metadata/createUserMetadataFieldTemplate" : { "post" : { "description" : "Create a new template user metadata field that will be applicable to all users in the organization, allowing custom field definitions for user data.", "operationId" : "createUserMetadataFieldTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create user metadata field template", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/deleteUserMetadataField" : { "post" : { "description" : "Deletes the specified user's value stored for the specified template, removing the custom field value while preserving the template definition.", "operationId" : "deleteUserMetadataField", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete user metadata field", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/deleteUserMetadataFieldTemplate" : { "post" : { "description" : "Delete a template user metadata field. THIS WILL DELETE THE CUSTOM FIELD AND USER DATA FOR THIS FIELD, permanently removing the field definition and all associated user values.", "operationId" : "deleteUserMetadataFieldTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete user metadata field template", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/findAllUserMetadataFieldsByOrg" : { "post" : { "description" : "Returns the org template metadata fields and every user's stored values for those fields, keyed by user uuid and then by template uuid. For callers that need the whole org at once, such as a user report, rather than one user at a time.", "operationId" : "findAllUserMetadataFieldsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindAllUserMetadataFieldsByOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindAllUserMetadataFieldsByOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find all user metadata fields in the org", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/findUserMetadataFieldTemplates" : { "post" : { "description" : "Find all template user metadata fields for the organization, returning the complete list of custom field definitions available for users.", "operationId" : "findUserMetadataFieldTemplates", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find user metadata field templates", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/findUserMetadataFields" : { "post" : { "description" : "Returns the org template metadata fields and the queried users stored values for those fields if they've been set, providing complete metadata information for a specific user.", "operationId" : "findUserMetadataFields", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Find user metadata fields", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/saveUserMetadataFields" : { "post" : { "description" : "Saves custom metadata values for the user specified. Template IDs that do not map to an actual org metadata template are ignored and values for omitted Template IDs are left as-is.", "operationId" : "saveUserMetadataFields", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Save user metadata fields", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/metadata/updateUserMetadataFieldTemplate" : { "post" : { "description" : "Update a template user metadata field that will be applicable to all users, allowing modification of existing custom field definitions.", "operationId" : "updateUserMetadataFieldTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update user metadata field template", "tags" : [ "User Metadata Webservice" ] } }, "/api/user/updatePartnerUser" : { "post" : { "description" : "Update a partner's details with partner-specific validation and audit logging.", "operationId" : "updatePartnerUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdatePartnerWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdatePartnerWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update partner user details", "tags" : [ "User Webservice" ] } }, "/api/user/updatePartnerUserNotificationSettings" : { "post" : { "description" : "Update notification settings for partner user with partner-specific notification configurations.", "operationId" : "updatePartnerUserNotificationSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update partner user notification settings", "tags" : [ "User Webservice" ] } }, "/api/user/updateRhombusKeySettingsForUser" : { "post" : { "description" : "Update the RhombusKey mobile app settings for the user, including access permissions and app configuration.", "operationId" : "updateRhombusKeySettingsForUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update Rhombus key settings for user", "tags" : [ "User Webservice" ] } }, "/api/user/updateUser" : { "post" : { "deprecated" : true, "description" : "Update a user's details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.", "operationId" : "updateUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update user details", "tags" : [ "User Webservice" ] } }, "/api/user/updateUserNotificationSettings" : { "post" : { "description" : "Update notification settings for user with various notification channels and preferences.", "operationId" : "updateUserNotificationSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update user notification settings", "tags" : [ "User Webservice" ] } }, "/api/user/updateUserSelective" : { "post" : { "description" : "Selectively updates a user's details. Omitted fields are ignored but fields with null will unset a value, providing granular control over user updates.", "operationId" : "updateUserSelective", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update user details selectively", "tags" : [ "User Webservice" ] } }, "/api/vehicle/addVehicleLabel" : { "post" : { "description" : "Add a label to a vehicle", "operationId" : "addVehicleLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Add vehicle label", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/associateEventsToVehicle" : { "post" : { "description" : "Associate vehicle events to a saved vehicle", "operationId" : "associateEventsToVehicle", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Associate events to vehicle", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/deleteVehicle" : { "post" : { "description" : "Delete a saved vehicle", "operationId" : "deleteVehicle", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete vehicle", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getRecentVehicleEvents" : { "post" : { "deprecated" : true, "description" : "Get recent vehicle events for organization. Use /vehicle/getVehicleEvents instead.", "operationId" : "getRecentVehicleEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent vehicle events", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getRecentVehicleEventsByLocation" : { "post" : { "deprecated" : true, "description" : "Get recent vehicle events for a location. Use /vehicle/getVehicleEvents instead.", "operationId" : "getRecentVehicleEventsByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent vehicle events by location", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getRecentVehicleEventsForVehicle" : { "post" : { "deprecated" : true, "description" : "Get recent vehicle events for specified vehicle. Use /vehicle/getVehicleEvents instead.", "operationId" : "getRecentVehicleEventsForVehicle", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get recent vehicle events for vehicle", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getVehicleEvents" : { "post" : { "description" : "Get vehicle events with filters and additive queries", "operationId" : "getVehicleEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get vehicle events", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getVehicleLabelsForOrg" : { "post" : { "description" : "Get all vehicle labels for organization", "operationId" : "getVehicleLabelsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get vehicle labels for organization", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/getVehicles" : { "post" : { "description" : "Get details of all saved vehicles in organization", "operationId" : "getVehicles", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get vehicles", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/removeVehicleLabel" : { "post" : { "description" : "Remove a label to a vehicle", "operationId" : "removeVehicleLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Remove vehicle label", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/reportVehicleEvent" : { "post" : { "description" : "Report a mis-detected license plate event. This sends the image/clip to Rhombus to better train AI models and removes the event", "operationId" : "reportVehicleEvent", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Report vehicle event", "tags" : [ "Vehicle Webservice" ] } }, "/api/vehicle/saveVehicle" : { "post" : { "description" : "Name and save a vehicle based on license plate number", "operationId" : "saveVehicle", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Save vehicle", "tags" : [ "Vehicle Webservice" ] } }, "/api/video/cancelSplice" : { "post" : { "deprecated" : true, "description" : "Use /cancelSpliceV2 instead", "operationId" : "cancelSplice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CancelSpliceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CancelSpliceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Cancel splice", "tags" : [ "Video Webservice" ] } }, "/api/video/cancelSpliceV2" : { "post" : { "description" : "Cancel a spliced clip request", "operationId" : "cancelSpliceV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CancelSpliceV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CancelSpliceV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Cancel splice V2", "tags" : [ "Video Webservice" ] } }, "/api/video/createSharedTimelapseGroup" : { "post" : { "description" : "Share multiple timelapses in one link", "operationId" : "createSharedTimelapseGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Create shared timelapse group", "tags" : [ "Video Webservice" ] } }, "/api/video/deleteSharedTimelapseGroup" : { "post" : { "description" : "Delete a shared timelapse link", "operationId" : "deleteSharedTimelapseGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete shared timelapse group", "tags" : [ "Video Webservice" ] } }, "/api/video/deleteTimelapseClips" : { "post" : { "description" : "Delete a timelapse", "operationId" : "deleteTimelapseClips", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Delete timelapse clips", "tags" : [ "Video Webservice" ] } }, "/api/video/generateRangedTimelapseClip" : { "post" : { "description" : "Generate a timelapse where each device facet contributes footage only during its own time ranges.", "operationId" : "generateRangedTimelapseClip", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GenerateRangedTimelapseClipWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GenerateRangedTimelapseClipWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate ranged timelapse clip", "tags" : [ "Video Webservice" ] } }, "/api/video/generateTimelapseClip" : { "post" : { "description" : "Generate a timelapse", "operationId" : "generateTimelapseClip", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Generate timelapse clip", "tags" : [ "Video Webservice" ] } }, "/api/video/getExactFrameData" : { "post" : { "description" : "Fetches and returns the bytes, base64 encoded, of the frame at the given timestamp for a device. Use this instead of getExactFrameUri if, for whatever reason, either the URI is not useful or the client is unable to hit the media servers. The response always has HTTP status 200; check the status field, frameData is only set when it is AVAILABLE.", "operationId" : "getExactFrameData", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetExactFrameDataWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetExactFrameDataWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get exact frame data", "tags" : [ "Video Webservice" ] } }, "/api/video/getExactFrameUri" : { "post" : { "description" : "Generate URL to get an exact frame with optional crop from a camera. The URL is served by the media relay the camera is connected to right now, so use it promptly. The response always has HTTP status 200; check the status field, and only treat the frame as retrievable when it is AVAILABLE.", "operationId" : "getExactFrameUri", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetExactFrameUriWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetExactFrameUriWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get exact frame URI", "tags" : [ "Video Webservice" ] } }, "/api/video/getLiveImage" : { "post" : { "description" : "Returns the most recent snapshot image the camera has captured, as a jpeg. Unlike getExactFrame this is not taken from recorded footage, so it only succeeds while the camera is online and actively capturing. Last-Modified carries the moment the camera captured the image.", "operationId" : "getLiveImage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetLiveImageWSRequest" } } } }, "responses" : { "200" : { "content" : { "image/jpeg" : { } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get live image", "tags" : [ "Video Webservice" ] } }, "/api/video/getMaxSpliceDuration" : { "post" : { "description" : "Get the max splice duration an organization can set", "operationId" : "getMaxSpliceDuration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get max splice duration", "tags" : [ "Video Webservice" ] } }, "/api/video/getSharedTimelapseGroups" : { "post" : { "description" : "Get details of all shared timelapse links for organization", "operationId" : "getSharedTimelapseGroups", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get shared timelapse groups", "tags" : [ "Video Webservice" ] } }, "/api/video/getSplicedClipsInProgress" : { "post" : { "description" : "Get all spliced clips in progress", "operationId" : "getSplicedClipsInProgress", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get spliced clips in progress", "tags" : [ "Video Webservice" ] } }, "/api/video/getTimelapseClips" : { "post" : { "description" : "Get all timelapse clips for organization", "operationId" : "getTimelapseClips", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get timelapse clips", "tags" : [ "Video Webservice" ] } }, "/api/video/getTimelapseMetadata" : { "post" : { "description" : "Get information about earliest available timelapse images for cameras", "operationId" : "getTimelapseMetadata", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Get timelapse metadata", "tags" : [ "Video Webservice" ] } }, "/api/video/retrySplice" : { "post" : { "description" : "Send a request to retry splicing a clip", "operationId" : "retrySplice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_RetrySpliceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_RetrySpliceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Retry splice", "tags" : [ "Video Webservice" ] } }, "/api/video/shareTimelapseClips" : { "post" : { "deprecated" : true, "description" : "Use /CreateSharedTimelapseGroup instead", "operationId" : "shareTimelapseClips", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Share timelapse clips", "tags" : [ "Video Webservice" ] } }, "/api/video/splice" : { "post" : { "deprecated" : true, "description" : "Use /spliceV3 instead", "operationId" : "splice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Splice", "tags" : [ "Video Webservice" ] } }, "/api/video/spliceFrame" : { "post" : { "description" : "Send a request to create a single image from a point in time", "operationId" : "spliceFrame", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceFrameWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceFrameWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Splice frame", "tags" : [ "Video Webservice" ] } }, "/api/video/spliceV2" : { "post" : { "deprecated" : true, "description" : "Use /spliceV3 instead", "operationId" : "spliceV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceV2WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceV2WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Splice V2", "tags" : [ "Video Webservice" ] } }, "/api/video/spliceV3" : { "post" : { "description" : "Send a request to create an arbitrary clip for multiple cameras", "operationId" : "spliceV3", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceV3WSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_SpliceV3WSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Splice V3", "tags" : [ "Video Webservice" ] } }, "/api/video/updateSharedTimelapseGroup" : { "post" : { "description" : "Update title, description, or expiration on a shared timelapse link", "operationId" : "updateSharedTimelapseGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSResponse" } } }, "description" : "OK" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "500" : { "$ref" : "#/components/responses/InternalServerError" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } }, "summary" : "Update shared timelapse group", "tags" : [ "Video Webservice" ] } } }, "components" : { "responses" : { "BadRequest" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND." }, "Conflict" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Conflict. errorCode is one of: CONFLICT, CONFIRM_NAME_MISMATCH, DUPLICATE_CLIENT_NAME, LICENSE_V2_DISABLED, INSUFFICIENT_POOL_LICENSES." }, "Forbidden" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT." }, "InternalServerError" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Internal Server Error. errorCode is one of: INTERNAL_ERROR." }, "NotFound" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Not Found. errorCode is one of: NOT_FOUND." }, "ServiceUnavailable" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE." }, "TooManyRequests" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Too Many Requests. errorCode is one of: RATE_LIMITED." }, "Unauthorized" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiErrorResponse" } } }, "description" : "Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH." } }, "schemas" : { "ACUDoorCatalogItem" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "ACUDoorLicenseType" : { "type" : "object", "description" : "List of access controlled door licenses available for the client organization", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AIReport" : { "type" : "object", "description" : "The AI report to update", "properties" : { "completedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "params" : { "$ref" : "#/components/schemas/AIReportGenerateParams" }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacy" : { "$ref" : "#/components/schemas/ChatPrivacy" }, "scheduleUuid" : { "type" : "string", "nullable" : true }, "scheduledAiReportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "structureJson" : { "type" : "string", "nullable" : true }, "timeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryTimelineEvent" }, "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "toolingTimeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryTool" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AIReportGenerateParams" : { "type" : "object", "properties" : { "additionalPrompt" : { "type" : "string", "nullable" : true }, "dataSources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DataSourceEnum" }, "nullable" : true }, "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "rangeEndMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "rangeStartMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AIReportGroup" : { "type" : "object", "description" : "List of AI reports", "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastModifiedMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "latestStatus" : { "$ref" : "#/components/schemas/QueryStatusEnum" }, "numReports" : { "type" : "integer", "format" : "int32", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacy" : { "$ref" : "#/components/schemas/ChatPrivacy" }, "scheduledAiReportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AITShipmentInfoType" : { "type" : "object", "nullable" : true, "properties" : { "aitTrackingNumber" : { "type" : "string", "nullable" : true }, "carrierTrackingNumber" : { "type" : "string", "nullable" : true }, "depositorOrderNumber" : { "type" : "string", "nullable" : true }, "destinationAddress" : { "type" : "string", "nullable" : true }, "isIngramDistributorShipment" : { "type" : "boolean", "nullable" : true }, "shipmentDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "shippedItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShippedItemType" }, "nullable" : true } } }, "ALMActionEnum" : { "type" : "string", "description" : "The ALM-related action that occurred.", "enum" : [ "LOCATION_CONFIG_CREATED", "LOCATION_CONFIG_UPDATED", "LOCATION_CONFIG_DELETED", "ZONE_CONFIG_CREATED", "ZONE_CONFIG_UPDATED", "ZONE_CONFIG_DELETED", "MONITORING_ENABLED", "MONITORING_DISABLED", "MONITORING_MANUALLY_ARMED", "MONITORING_MANUAL_ARM_CANCELED", "MONITORING_MANUALLY_PAUSED", "MONITORING_MANUAL_PAUSE_CANCELED", "MONITORING_SCHEDULE_UPDATE", "MARK_LOCATION_FOR_CLEANUP", "UNMARK_LOCATION_FOR_CLEANUP", "LOCATION_CLEANED_UP", "UNKNOWN" ] }, "ALMConfig" : { "type" : "object", "description" : "A snapshot of the ALM config after this event succeeded.", "discriminator" : { "propertyName" : "type" }, "properties" : { "deleted" : { "type" : "boolean", "description" : "Indication of whether this config was deleted.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/TypeEnum" }, "versionInfo" : { "$ref" : "#/components/schemas/ALMModificationMetadata" }, "zoneId" : { "type" : "string", "nullable" : true } }, "required" : [ "locationUuid" ] }, "ALMEvent" : { "type" : "object", "description" : "List of modification events showing who made changes", "properties" : { "action" : { "$ref" : "#/components/schemas/ALMActionEnum" }, "auditInfo" : { "$ref" : "#/components/schemas/ALMModificationMetadata" }, "config" : { "$ref" : "#/components/schemas/ALMConfig" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "monitoringState" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "outcome" : { "$ref" : "#/components/schemas/DaoOutcomeEnum" }, "reason" : { "type" : "string", "description" : "Optional underlying reason for the result of the ALM-related action.", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "zoneId" : { "type" : "string", "description" : "ID of the ALM zone this event occurred with.", "nullable" : true } } }, "ALMEventFilter" : { "type" : "object", "description" : "Optional filter to narrow results by timestamp, action, and/or outcome.", "properties" : { "actions" : { "type" : "array", "description" : "If specified, retrieves results matching these actions.", "items" : { "$ref" : "#/components/schemas/ALMActionEnum" }, "nullable" : true, "uniqueItems" : true }, "afterMs" : { "type" : "integer", "format" : "int64", "description" : "Retrieve events occurring at or after this timestamp (ms).", "nullable" : true }, "beforeMs" : { "type" : "integer", "format" : "int64", "description" : "Retrieve events occurring at or before this timestamp (ms).", "nullable" : true }, "outcomes" : { "type" : "array", "description" : "If specified, retrieves results matching these outcomes.", "items" : { "$ref" : "#/components/schemas/DaoOutcomeEnum" }, "nullable" : true, "uniqueItems" : true } } }, "ALMManualPolicySummary" : { "type" : "object", "description" : "Status of the ALM zone when operating in manual monitoring mode.", "properties" : { "armable" : { "type" : "boolean", "description" : "Indicates whether this policy is armable. If the policy is not properly configured, it cannot be armed/disarmed.\n", "nullable" : true }, "armed" : { "type" : "boolean", "description" : "Indicates whether the ALM zone is currently armed in manual monitoring mode.", "nullable" : true }, "rearmedAfterMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX epoch timestamp (in milliseconds) when the ALM zone re-arms.", "nullable" : true }, "summary" : { "type" : "string", "description" : "Explanation of the current manual monitoring state.", "nullable" : true } } }, "ALMModificationMetadata" : { "type" : "object", "description" : "Info regarding when and by whom this status was modified.", "properties" : { "modifiedAtMs" : { "type" : "integer", "format" : "int64", "description" : "UNIX timestamp (in milliseconds) when the ALM config or state was modified.", "nullable" : true }, "modifiedBy" : { "type" : "string", "description" : "The user/principal/entity that made the modification.", "nullable" : true }, "modifiedByIntegration" : { "type" : "boolean", "description" : "Indication of whether the modification was due to an integration.", "nullable" : true }, "modifiedByMetadata" : { "type" : "string", "description" : "Metadata describing when and under what conditions these modifications occurred.", "nullable" : true }, "modifiedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ALMMonitoringState" : { "type" : "object", "description" : "A snapshot of the ALM state after this event succeeded.", "properties" : { "armingRule" : { "$ref" : "#/components/schemas/ArmMonitoringRule" }, "auditInfo" : { "$ref" : "#/components/schemas/ALMModificationMetadata" }, "disarmingRule" : { "$ref" : "#/components/schemas/DisarmMonitoringRule" }, "enabledSinceMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX timestamp (in milliseconds) when manual monitoring was enabled.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "manualMonitoringEnabled" : { "type" : "boolean", "description" : "Indication of whether monitoring is enabled for manual monitoring mode.", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rearmingRule" : { "$ref" : "#/components/schemas/RearmMonitoringRule" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "ALMScheduledPolicySummary" : { "type" : "object", "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", "properties" : { "alarmPolicyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "armable" : { "type" : "boolean", "description" : "Indicates whether this policy is armable. If the policy is not properly configured, it cannot be armed/disarmed.\n", "nullable" : true }, "armed" : { "type" : "boolean", "description" : "Indicates whether the ALM zone is currently armed under this scheduled policy.", "nullable" : true }, "armedEndMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window ends (exclusive).\n", "nullable" : true }, "armedStartMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window begins (inclusive).\n", "nullable" : true }, "summary" : { "type" : "string", "description" : "Explanation of the scheduled monitoring state for this policy.", "nullable" : true } } }, "ALMZoneContext" : { "type" : "object", "description" : "List of the latest ALM zone contexts in the org.", "properties" : { "locationConfig" : { "$ref" : "#/components/schemas/LocationALMConfig" }, "monitoringState" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "zoneConfig" : { "$ref" : "#/components/schemas/ZoneALMConfig" } } }, "ALMZoneSummary" : { "type" : "object", "description" : "List of summaries of the ALM zone statuses in the org.", "properties" : { "deviceLastPlayedAudioAtMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", "nullable" : true }, "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", "nullable" : true }, "deviceSirenActivatedAtMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", "nullable" : true }, "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", "nullable" : true }, "deviceSirenTriggeredByRule" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "description" : "Per device, the UUID of the alarm rule that triggered the siren.", "nullable" : true }, "fullyConfigured" : { "type" : "boolean", "description" : "Indicates whether this ALM zone is capable of producing a summary. True if a location config, zone config, and monitoring state exist for this zone.\n", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "manualPolicySummary" : { "$ref" : "#/components/schemas/ALMManualPolicySummary" }, "mode" : { "type" : "string", "description" : "The current monitoring mode for the ALM zone (e.g., MANUAL or SCHEDULED).", "nullable" : true }, "scheduledPolicySummaries" : { "type" : "array", "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", "items" : { "$ref" : "#/components/schemas/ALMScheduledPolicySummary" }, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "AMSirenSettingsType" : { "type" : "object", "properties" : { "audioGateways" : { "type" : "array", "description" : "UUIDs of audio gateways used to play this siren.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSeconds" : { "type" : "integer", "format" : "int32", "description" : "The duration (in seconds) to loop the clip audio for the siren.", "nullable" : true }, "playCount" : { "type" : "integer", "format" : "int32", "description" : "The number of times to play the clip audio for the siren.", "nullable" : true } }, "required" : [ "audioGateways", "clipUuid" ] }, "AbsoluteSecondsIntervalType" : { "type" : "object", "properties" : { "b" : { "type" : "integer", "format" : "int64", "nullable" : true }, "e" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AbsoluteSecondsScheduleType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "intervalList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "internalWriteOnly" : { "type" : "boolean", "nullable" : true }, "mutable" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "oneTimeUse" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "strategy" : { "$ref" : "#/components/schemas/ScheduleStrategyEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlAuthenticationResultEnumType" : { "type" : "string", "enum" : [ "ACCEPTED", "REJECTED", "ERROR", "NA" ] }, "AccessControlAuthorizationResultEnumType" : { "type" : "string", "enum" : [ "ALLOWED", "DENIED", "DISABLED", "ERROR", "NA" ] }, "AccessControlCredentialAssigneeTypeEnum" : { "type" : "string", "enum" : [ "USER", "GUEST_PASS" ] }, "AccessControlCredentialEnumType" : { "type" : "string", "enum" : [ "STANDARD_CSN", "RHOMBUS_SECURE_CSN", "RHOMBUS_SECURE_MOBILE", "APPLE_WALLET_DESFIRE", "PIN_CODE", "WIEGAND_H10301", "WIEGAND_H10304", "WIEGAND_H10302", "WIEGAND_D10202", "WIEGAND_64BIT_RAW", "HID_CORP1000_STD_35", "HID_CORP1000_STD_48", "QR_CODE_STATIC", "CUSTOM" ] }, "AccessControlCredentialType" : { "type" : "object", "description" : "Credentials assigned to the pass.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/StandardCsnType" }, { "$ref" : "#/components/schemas/RhombusSecureCsnType" }, { "$ref" : "#/components/schemas/RhombusSecureMobileType" }, { "$ref" : "#/components/schemas/PinCredential" }, { "$ref" : "#/components/schemas/WiegandH10301CredentialType" }, { "$ref" : "#/components/schemas/WiegandH10304Credential" }, { "$ref" : "#/components/schemas/WiegandH10302Credential" }, { "$ref" : "#/components/schemas/WiegandD10202Credential" }, { "$ref" : "#/components/schemas/Wiegand64BitRawCredentialType" }, { "$ref" : "#/components/schemas/Wiegand35BitCorp1000Credential" }, { "$ref" : "#/components/schemas/Wiegand48BitCorp1000Credential" }, { "$ref" : "#/components/schemas/QrCodeStaticCredential" }, { "$ref" : "#/components/schemas/CustomCredential" } ], "properties" : { "assigneeType" : { "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" }, "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedAccessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUsedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lowercaseHexValue" : { "type" : "string", "nullable" : true, "readOnly" : true }, "managedCredUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "nullable" : true }, "workflowStatus" : { "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, "AccessControlCredentialWorkflowStatusEnumType" : { "type" : "string", "enum" : [ "ACTIVE", "UNASSIGNED", "SUSPENDED", "REVOKED" ] }, "AccessControlUnitBatteryStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "batteryFound" : { "type" : "boolean", "nullable" : true }, "batteryMa" : { "type" : "integer", "format" : "int32", "nullable" : true }, "batteryMv" : { "type" : "integer", "format" : "int32", "nullable" : true }, "onBackupPower" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlUnitDoorFirstInStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "doorAuthFirstInEventReference" : { "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" }, "doorScheduleFirstInEventReference" : { "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" }, "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlUnitLocationLockdownStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatedLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, "activeLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, "deactivatedLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, "doorEventReferenceMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DoorLockdownStateEventReference" }, "nullable" : true }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationLockdownStateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlUnitTamperEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "source" : { "$ref" : "#/components/schemas/AccessControlUnitTamperSourceEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlUnitTamperSourceEnumType" : { "type" : "string", "enum" : [ "PROX", "ACCEL", "SWITCH", "NA" ] }, "AccessControlledDoorPolicyAlertType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "initiatingUsername" : { "type" : "string", "nullable" : true }, "originatorEntityName" : { "type" : "string", "nullable" : true }, "originatorEntityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originatorType" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } } ], "nullable" : true, "properties" : { "alertMonitoringThreatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "alertMonitoringVerified" : { "type" : "boolean", "nullable" : true }, "archived" : { "type" : "boolean", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/ApiClientTypeEnum" }, "clipLocationMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "nullable" : true }, "clipLocationMapV2" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "delayedProcessing" : { "type" : "boolean", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "finalized" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "notificationSent" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saved" : { "type" : "boolean", "nullable" : true }, "serverReceivedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "shared" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "textDescription" : { "type" : "string", "description" : "Natural language description of the alert", "nullable" : true }, "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "thumbnailLocationV2" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/PolicyAlertEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlledDoorPolicyType" : { "type" : "object", "description" : "List of access controlled door policies using the schedule", "properties" : { "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlledDoorScheduledTriggerType" : { "type" : "object", "properties" : { "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true } } }, "AccessControlledDoorShadow" : { "type" : "object", "properties" : { "authFirstIn" : { "$ref" : "#/components/schemas/FirstInShadow" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduleFirstIn" : { "$ref" : "#/components/schemas/FirstInShadow" }, "state" : { "$ref" : "#/components/schemas/AccessStateShadow" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AccessControlledDoorStateEnumType" : { "type" : "string", "enum" : [ "UNLOCKED", "ACCESS_CONTROLLED" ] }, "AccessControlledDoorSubTypeEnum" : { "type" : "string", "enum" : [ "RHOMBUS", "APERIO", "APERIO_RS485", "SCHLAGE_R485" ] }, "AccessControlledDoorSubTypeEnum_Minimal" : { "type" : "string", "enum" : [ "RHOMBUS", "APERIO", "APERIO_RS485", "SCHLAGE_R485" ] }, "AccessControlledDoorType" : { "type" : "object", "properties" : { "ajarTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "apbMode" : { "$ref" : "#/components/schemas/AntiPassbackModeEnum" }, "apbZoneId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "aperioDoorExtensionComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "buttonComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultAccessStateOriginator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "defaultAccessStateRequestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "doorAuthFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState" }, "doorScheduleFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState" }, "doorStateOverride" : { "$ref" : "#/components/schemas/BaseAccessStateOverride" }, "doorStateToScheduleUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "dpiComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forcedOpenEnabled" : { "type" : "boolean", "nullable" : true }, "forcedOpenTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "nfcSecureDowngradeEnabled" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacyModeSupportEnabled" : { "type" : "boolean", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "relayComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "relockAfterOpenTimeMs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "rexComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "schlageDoorExtensionComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "schlageGatewayComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "schlageGatewayRs485Address" : { "type" : "integer", "format" : "int32", "nullable" : true }, "schlageRs485Address" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sendExpiredIntentEvents" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subType" : { "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType" }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "unlockTimeSecRex" : { "type" : "integer", "format" : "int32", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, "AccessControlledDoorType_Minimal" : { "type" : "object", "description" : "List of access controlled doors", "properties" : { "apbMode" : { "$ref" : "#/components/schemas/AntiPassbackModeEnum_Minimal" }, "apbZoneId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "aperioDoorExtensionComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "buttonComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "doorAuthFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState_Minimal" }, "doorScheduleFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState_Minimal" }, "doorStateOverride" : { "$ref" : "#/components/schemas/BaseAccessStateOverride_Minimal" }, "dpiComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "nfcSecureDowngradeEnabled" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacyModeSupportEnabled" : { "type" : "boolean", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType_Minimal" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "relayComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "rexComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "schlageDoorExtensionComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "schlageGatewayComponent" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "schlageGatewayRs485Address" : { "type" : "integer", "format" : "int32", "nullable" : true }, "schlageRs485Address" : { "type" : "integer", "format" : "int32", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subType" : { "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum_Minimal" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType_Minimal" } } }, "AccessControlledElevator" : { "type" : "object", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "elevatorLandingReferences" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ElevatorLandingReference" }, "nullable" : true }, "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "nfcSecureDowngradeEnabled" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "sendExpiredIntentEvents" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType" }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, "AccessControlledElevatorLanding" : { "type" : "object", "description" : "The updated elevator landing after applying the first-in state.", "properties" : { "accessScheduleFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState" }, "accessStateOverride" : { "$ref" : "#/components/schemas/BaseAccessStateOverride" }, "accessStateToScheduleUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "authFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultAccessState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "defaultAccessStateOriginator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "defaultAccessStateRequestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlledElevatorLandingShadow" : { "type" : "object", "properties" : { "authFirstIn" : { "$ref" : "#/components/schemas/FirstInShadow" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduleFirstIn" : { "$ref" : "#/components/schemas/FirstInShadow" }, "state" : { "$ref" : "#/components/schemas/AccessStateShadow" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AccessControlledElevatorLanding_Minimal" : { "type" : "object", "description" : "List of access controlled elevator landings", "properties" : { "accessScheduleFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState_Minimal" }, "accessStateOverride" : { "$ref" : "#/components/schemas/BaseAccessStateOverride_Minimal" }, "authFirstInStateOverride" : { "$ref" : "#/components/schemas/FirstInState_Minimal" }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AccessControlledElevator_Minimal" : { "type" : "object", "description" : "List of access controlled elevators owning the returned landings", "properties" : { "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "elevatorLandingReferences" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ElevatorLandingReference_Minimal" }, "nullable" : true }, "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "nfcSecureDowngradeEnabled" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType_Minimal" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "sendExpiredIntentEvents" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType_Minimal" } } }, "AccessGrantModeEnum" : { "type" : "string", "enum" : [ "GUEST_PASS_INDIVIDUAL", "DEFAULT" ] }, "AccessStateAndSource" : { "type" : "object", "properties" : { "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockedDown" : { "type" : "boolean", "nullable" : true }, "scheduleName" : { "type" : "string", "description" : "Name of the schedule if derived from a shared schedule", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "source" : { "$ref" : "#/components/schemas/AccessStatefulComponentCompositeStateSourceEnum" }, "sourceId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sourceName" : { "type" : "string", "description" : "Name of the source", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } } }, "AccessStateBlock" : { "type" : "object", "properties" : { "active" : { "$ref" : "#/components/schemas/AccessStateAndSource" }, "default" : { "$ref" : "#/components/schemas/AccessStateAndSource" }, "firstInRequirementSatisfied" : { "type" : "boolean", "nullable" : true }, "ifFirstInRequired" : { "$ref" : "#/components/schemas/AccessStateAndSource" }, "ifFirstInSatisfied" : { "$ref" : "#/components/schemas/AccessStateAndSource" }, "ifOverrideRemoved" : { "$ref" : "#/components/schemas/AccessStateAndSource" } } }, "AccessStateChange" : { "type" : "object", "properties" : { "causes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessStateChangeCauseEnum" }, "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/AccessStateAndSource" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AccessStateChangeCauseEnum" : { "type" : "string", "enum" : [ "SCHEDULE_START", "SCHEDULE_END", "DSE_START", "DSE_END", "DSE_SCHEDULE_START", "DSE_SCHEDULE_END", "FIRST_IN_RESET", "OVERRIDE_BEGIN", "OVERRIDE_EXPIRE", "OVERRIDE_EXPIRE_EARLY", "UNKNOWN" ] }, "AccessStateOverride" : { "type" : "object", "nullable" : true, "properties" : { "expireEarlyMode" : { "$ref" : "#/components/schemas/EarlyExpireModeEnum" }, "expiresAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "followFirstInRules" : { "type" : "boolean", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDelaySeconds" : { "type" : "integer", "format" : "int64", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "type" : { "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" } } }, "AccessStateOverrideExpirationStrategyEnum" : { "type" : "string", "enum" : [ "TIME_DELAY", "TIME_OF_DAY_LOCAL", "NONE" ] }, "AccessStateShadow" : { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "source" : { "$ref" : "#/components/schemas/AccessStateSourceEnum" }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AccessStateSourceEnum" : { "type" : "string", "enum" : [ "DEFAULT_STATE", "SCHEDULE", "SCHEDULE_EXCEPTION", "FIRST_IN", "DOOR_STATE_OVERRIDE", "LOCKDOWN", "PRIVACY", "UNKNOWN" ] }, "AccessStatefulComponentCompositeStateSourceEnum" : { "type" : "string", "enum" : [ "DEFAULT_STATE", "DOOR_SCHEDULE", "DSE_DEFAULT_STATE", "DSE_SCHEDULE", "DOOR_STATE_OVERRIDE", "LOCKDOWN" ] }, "Accesscontrol_BaseSendUserPresenceForCurrentUserWsResponse" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_Create35BitCorp1000StdCredentialWSRequest" : { "type" : "object", "description" : "Request to create an HID Corp1000 Standard 35 Bit credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int64", "description" : "Card number", "example" : 456789, "nullable" : true }, "companyId" : { "type" : "integer", "format" : "int32", "description" : "Company Id", "example" : 123, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_Create35BitCorp1000StdCredentialWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_Create48BitCorp1000StdCredentialWSRequest" : { "type" : "object", "description" : "Request to create an HID Corp1000 Standard 48 Bit credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int64", "description" : "Card number", "example" : 456789, "nullable" : true }, "companyId" : { "type" : "integer", "format" : "int32", "description" : "Company Id", "example" : 123, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_Create48BitCorp1000StdWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_DeviceUnlockableAccessControlledDoorType" : { "type" : "object", "description" : "Represents an access controlled door that can be unlocked by a device.", "properties" : { "name" : { "type" : "string", "description" : "The name of the access controlled door.", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSRequest" : { "type" : "object", "description" : "Request to find unlockable access controlled doors by device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSResponse" : { "type" : "object", "description" : "Response containing unlockable access controlled doors for a device.", "properties" : { "accessControlledDoors" : { "type" : "array", "description" : "List of unlockable access controlled doors", "items" : { "$ref" : "#/components/schemas/Accesscontrol_DeviceUnlockableAccessControlledDoorType" }, "nullable" : true } } }, "Accesscontrol_ForceRefreshAccessControlUnitConfigWSRequest" : { "type" : "object", "description" : "Request to force refresh an access control unit configuration.", "properties" : { "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_ForceRefreshAccessControlUnitConfigWSResponse" : { "type" : "object", "description" : "Response for force refresh access control unit configuration operation." }, "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to get minimal access controlled doors by location for current user.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSResponse" : { "type" : "object", "description" : "Response containing minimal access controlled doors by location for current user.", "properties" : { "accessControlledDoors" : { "type" : "array", "description" : "List of access controlled doors", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType_Minimal" }, "nullable" : true }, "accessControlledElevatorLandings" : { "type" : "array", "description" : "List of access controlled elevator landings", "items" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding_Minimal" }, "nullable" : true }, "accessControlledElevators" : { "type" : "array", "description" : "List of access controlled elevators owning the returned landings", "items" : { "$ref" : "#/components/schemas/AccessControlledElevator_Minimal" }, "nullable" : true }, "accessGrants" : { "type" : "array", "description" : "List of user access grants", "items" : { "$ref" : "#/components/schemas/Accesscontrol_UserAccessGrant" }, "nullable" : true }, "accessRevocations" : { "type" : "array", "description" : "List of user access revocations", "items" : { "$ref" : "#/components/schemas/Accesscontrol_UserAccessRevocation" }, "nullable" : true }, "schedules" : { "type" : "array", "description" : "List of schedules", "items" : { "$ref" : "#/components/schemas/BaseSavedScheduleType_Minimal" }, "nullable" : true } } }, "Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" : { "type" : "object", "allOf" : [ ], "description" : "Error response for send user presence for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for send user presence for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_SendUserPresenceForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to send user presence information for the current user.", "properties" : { "cmdVersion" : { "type" : "string", "format" : "byte", "nullable" : true }, "credentialValue" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "destinations" : { "type" : "array", "description" : "List of destinations for user presence", "items" : { "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" }, "nullable" : true } } }, "Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" : { "type" : "object", "description" : "Destination information for user presence.", "properties" : { "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "beaconIdentifier" : { "type" : "array", "description" : "Beacon identifier", "items" : { "type" : "string", "format" : "byte", "description" : "Beacon identifier", "nullable" : true }, "nullable" : true }, "readerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rssi" : { "type" : "string", "format" : "byte", "description" : "RSSI value of the reader as observed from the mobile device", "example" : "LTY1", "nullable" : true } } }, "Accesscontrol_UnlockAccessControlledDoorEnumType" : { "type" : "string", "description" : "Enumeration of possible errors when unlocking an access controlled door.", "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "DOOR_NOT_CONFIGURED_WITH_LOCK", "ACD_LICENSE_UNASSIGNED_OR_EXPIRED" ] }, "Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "errorType" : { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorEnumType" } } } ], "description" : "Error response for unlock access controlled door operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" : { "type" : "string", "description" : "Enumeration of possible errors when unlocking an access controlled door for the current user.", "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "DOOR_NOT_CONFIGURED_WITH_LOCK", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] }, "Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "errorType" : { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" } } } ], "description" : "Error response for unlock access controlled door for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for unlock access controlled door for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledDoorForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to unlock an access controlled door for the current user.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "cmdVersion" : { "type" : "string", "format" : "byte", "nullable" : true }, "credentialValue" : { "type" : "string", "description" : "Credential value for authentication", "example" : "credential123", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude of the mobile device for geofencing", "example" : 37.7749, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude of the mobile device for geofencing", "example" : -122.4194, "nullable" : true }, "requestTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "Request time in milliseconds", "example" : 1640995200000, "nullable" : true } } }, "Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for unlock access controlled door operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledDoorWSRequest" : { "type" : "object", "description" : "Request to unlock an access controlled door.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_UnlockAccessControlledElevatorEnumType" : { "type" : "string", "description" : "Enumeration of possible errors when unlocking an access controlled elevator.", "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "ELEVATOR_NOT_CONFIGURED_WITH_LANDING" ] }, "Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "errorType" : { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorEnumType" } } } ], "description" : "Error response for unlock access controlled elevator operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" : { "type" : "string", "description" : "Enumeration of possible errors when unlocking an access controlled elevator for the current user.", "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "ELEVATOR_NOT_CONFIGURED_WITH_LANDINGS", "INVALID_LANDINGS", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] }, "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "errorType" : { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" } } } ], "description" : "Error response for unlock access controlled elevator for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for unlock access controlled elevator for current user operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to unlock an access controlled elevator for the current user.", "properties" : { "accessControlledElevatorLandingUuids" : { "type" : "array", "description" : "UUIDs of specific access controlled elevator landings", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "cmdVersion" : { "type" : "string", "format" : "byte", "nullable" : true }, "credentialValue" : { "type" : "string", "description" : "Credential value for authentication", "example" : "credential123", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude of the mobile device for geofencing", "example" : 37.7749, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude of the mobile device for geofencing", "example" : -122.4194, "nullable" : true }, "requestTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "Request time in milliseconds", "example" : 1640995200000, "nullable" : true } } }, "Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for unlock access controlled elevator operation.", "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_UnlockAccessControlledElevatorWSRequest" : { "type" : "object", "description" : "Request to unlock an access controlled elevator, and optionally specific landings on that elevator.", "properties" : { "accessControlledElevatorLandingUuids" : { "type" : "array", "description" : "UUIDs of specific access controlled elevator landings", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_UserAccessGrant" : { "type" : "object", "description" : "Access grant information for a user containing schedule and door access permissions.", "properties" : { "accessControlledDoorUuids" : { "type" : "array", "description" : "Set of access controlled door UUIDs that this grant provides access to.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "description" : "Set of access controlled elevator landing UUIDs that this grant provides access to.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_UserAccessRevocation" : { "type" : "object", "description" : "Access revocation information for a user containing schedule and door access restrictions.", "properties" : { "accessControlledDoorUuids" : { "type" : "array", "description" : "Set of access controlled door UUIDs that this revocation restricts access to.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "description" : "Set of access controlled elevator landing UUIDs that this revocation restricts access to.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_CreateAccessGrantWSRequest" : { "type" : "object", "description" : "Request to create a location access grant.", "properties" : { "accessGrant" : { "$ref" : "#/components/schemas/LocationAccessGrantType" } } }, "Accesscontrol_accessgrant_CreateAccessGrantWSResponse" : { "type" : "object", "description" : "Response containing the created location access grant.", "properties" : { "accessGrant" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSRequest" : { "type" : "object", "description" : "Request to delete a location access grant.", "properties" : { "accessGrantUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSResponse" : { "type" : "object", "description" : "Response for location access grant deletion." }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSRequest" : { "type" : "object", "description" : "Request to find location access grants by access controlled door.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSResponse" : { "type" : "object", "description" : "Response containing location access grants for an access controlled door.", "nullable" : true, "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSRequest" : { "type" : "object", "description" : "Request to find location access grants by access controlled elevator landing.", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSResponse" : { "type" : "object", "description" : "Response containing location access grants for an access controlled elevator landing.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSRequest" : { "type" : "object", "description" : "Request to find location access grants by door label.", "properties" : { "doorLabelId" : { "type" : "string", "description" : "Door label identifier", "example" : "door_label_123", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSResponse" : { "type" : "object", "description" : "Response containing location access grants for a door label.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSRequest" : { "type" : "object", "description" : "Request to find location access grants by group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSResponse" : { "type" : "object", "description" : "Response containing location access grants for a group.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSRequest" : { "type" : "object", "description" : "Request to find location access grants by location and user.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSResponse" : { "type" : "object", "description" : "Response containing location access grants for a location and user.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSRequest" : { "type" : "object", "description" : "Request to find location access grants by location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSResponse" : { "type" : "object", "description" : "Response containing location access grants for a location.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSRequest" : { "type" : "object", "description" : "Request to find location access grants by organization." }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSResponse" : { "type" : "object", "description" : "Response containing location access grants for an organization.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSRequest" : { "type" : "object", "description" : "Request to find location access grants by user.", "properties" : { "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSResponse" : { "type" : "object", "description" : "Response containing location access grants for a user.", "properties" : { "accessGrants" : { "type" : "array", "description" : "List of location access grants", "items" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_GetLocationAccessGrantWSRequest" : { "type" : "object", "description" : "Request to get a location access grant by UUID.", "properties" : { "accessGrantUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_GetLocationAccessGrantWSResponse" : { "type" : "object", "description" : "Response containing a location access grant.", "properties" : { "accessGrant" : { "$ref" : "#/components/schemas/LocationAccessGrantType" } } }, "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to get locations by access grant for current user." }, "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSResponse" : { "type" : "object", "description" : "Response for getting locations by access grant for current user.", "properties" : { "locationLockdownStates" : { "type" : "array", "description" : "List of location lockdown states", "items" : { "$ref" : "#/components/schemas/LocationLockdownStateType" }, "nullable" : true }, "locations" : { "type" : "array", "description" : "List of locations accessible to the current user", "items" : { "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, "lockdownPlans" : { "type" : "array", "description" : "List of lockdown plans for the locations", "items" : { "$ref" : "#/components/schemas/BaseLockdownPlanType" }, "nullable" : true } } }, "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to get Rhombus Key location lockdown details for current user.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSResponse" : { "type" : "object", "description" : "Response for getting Rhombus Key location lockdown details for current user.", "properties" : { "locationLockdownState" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_accessgrant_UpdateAccessGrantWSRequest" : { "type" : "object", "description" : "Request to update a location access grant.", "properties" : { "accessGrant" : { "$ref" : "#/components/schemas/LocationAccessGrantType" } } }, "Accesscontrol_accessgrant_UpdateAccessGrantWSResponse" : { "type" : "object", "description" : "Response for location access grant update.", "properties" : { "accessGrant" : { "$ref" : "#/components/schemas/LocationAccessGrantType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_accessrevocation_CreateAccessRevocationWSRequest" : { "type" : "object", "description" : "Request to create a location access revocation.", "properties" : { "accessRevocation" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" } } }, "Accesscontrol_accessrevocation_CreateAccessRevocationWSResponse" : { "type" : "object", "description" : "Response for location access revocation creation.", "properties" : { "accessRevocation" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSRequest" : { "type" : "object", "description" : "Request to delete a location access revocation.", "properties" : { "accessRevocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSResponse" : { "type" : "object", "description" : "Response for location access revocation deletion." }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by access controlled door.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for an access controlled door.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by access controlled elevator landing.", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for an access controlled elevator landing.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by door label.", "properties" : { "doorLabelId" : { "type" : "string", "description" : "Door label identifier", "example" : "door_label_123", "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for a door label.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for a group.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by organization." }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for an organization.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSRequest" : { "type" : "object", "description" : "Request to find location access revocations by user.", "properties" : { "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSResponse" : { "type" : "object", "description" : "Response containing location access revocations for a user.", "properties" : { "accessRevocations" : { "type" : "array", "description" : "List of location access revocations", "items" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "nullable" : true } } }, "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSRequest" : { "type" : "object", "description" : "Request to get a location access revocation by UUID.", "properties" : { "accessRevocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSResponse" : { "type" : "object", "description" : "Response containing a location access revocation.", "properties" : { "accessRevocation" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" } } }, "Accesscontrol_accessrevocation_UpdateAccessRevocationWSRequest" : { "type" : "object", "description" : "Request to update a location access revocation.", "properties" : { "accessRevocation" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" } } }, "Accesscontrol_accessrevocation_UpdateAccessRevocationWSResponse" : { "type" : "object", "description" : "Response for location access revocation update operation.", "properties" : { "accessRevocation" : { "$ref" : "#/components/schemas/LocationAccessRevocationType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_badgetemplate_CreateBadgeTemplateWSRequest" : { "type" : "object", "description" : "Request to create a new badge template.", "properties" : { "template" : { "$ref" : "#/components/schemas/BadgeTemplate" } } }, "Accesscontrol_badgetemplate_CreateBadgeTemplateWSResponse" : { "type" : "object", "description" : "Response containing the created badge template.", "properties" : { "template" : { "$ref" : "#/components/schemas/BadgeTemplate" } } }, "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSRequest" : { "type" : "object", "description" : "Request to delete a specific badge template image by UUID.", "properties" : { "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSResponse" : { "type" : "object", "description" : "Response containing the deleted badge template image metadata.", "properties" : { "image" : { "$ref" : "#/components/schemas/BadgeTemplateImage" } } }, "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSRequest" : { "type" : "object", "description" : "Request to delete a specific badge template by UUID.", "properties" : { "templateUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSResponse" : { "type" : "object", "description" : "Response containing the deleted badge template.", "properties" : { "template" : { "$ref" : "#/components/schemas/BadgeTemplate" } } }, "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSRequest" : { "type" : "object", "description" : "Request to search for badge template images with pagination support.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSResponse" : { "type" : "object", "description" : "Response containing a list of badge template images with pagination information.", "properties" : { "images" : { "type" : "array", "description" : "List of badge template images found in the search.", "items" : { "$ref" : "#/components/schemas/BadgeTemplateImage" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true } } }, "Accesscontrol_badgetemplate_FindBadgeTemplatesWSRequest" : { "type" : "object", "description" : "Request to search for badge templates with pagination support.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, "Accesscontrol_badgetemplate_FindBadgeTemplatesWSResponse" : { "type" : "object", "description" : "Response containing a list of badge templates with pagination information.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, "templates" : { "type" : "array", "description" : "List of badge templates found in the search.", "items" : { "$ref" : "#/components/schemas/BadgeTemplate" }, "nullable" : true } } }, "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSRequest" : { "type" : "object", "description" : "Request to retrieve metadata for a specific badge template image by UUID.", "properties" : { "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSResponse" : { "type" : "object", "description" : "Response containing the requested badge template image metadata.", "properties" : { "image" : { "$ref" : "#/components/schemas/BadgeTemplateImage" } } }, "Accesscontrol_badgetemplate_GetBadgeTemplateWSRequest" : { "type" : "object", "description" : "Request to retrieve a specific badge template by UUID.", "properties" : { "templateUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_badgetemplate_GetBadgeTemplateWSResponse" : { "type" : "object", "description" : "Response containing the requested badge template.", "properties" : { "template" : { "$ref" : "#/components/schemas/BadgeTemplate" } } }, "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSRequest" : { "type" : "object", "description" : "Request to update metadata for a badge template image with selective field updates.", "properties" : { "selectiveUpdate" : { "$ref" : "#/components/schemas/BadgeTemplateImageSelectiveUpdate" } } }, "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSResponse" : { "type" : "object", "description" : "Response containing the updated badge template image metadata.", "properties" : { "image" : { "$ref" : "#/components/schemas/BadgeTemplateImage" } } }, "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSRequest" : { "type" : "object", "description" : "Request to update an existing badge template with selective field updates.", "properties" : { "selectiveUpdate" : { "$ref" : "#/components/schemas/BadgeTemplateSelectiveUpdate" } } }, "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSResponse" : { "type" : "object", "description" : "Response containing the updated badge template.", "properties" : { "template" : { "$ref" : "#/components/schemas/BadgeTemplate" } } }, "Accesscontrol_credentials_AssignAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to assign an access control credential to a user.", "properties" : { "credentialHexValue" : { "type" : "string", "description" : "Hex value of the credential", "example" : "1234567890ABCDEF", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_AssignAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response for assigning an access control credential to a user.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_BaseProvisionMobileAccessControlCredentialForCurrentUserWSResponse" : { "type" : "object", "discriminator" : { "mapping" : { "ERROR" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse", "SUCCESS" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" }, "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_BaseUnlockAccessControlledDoorForCurrentUserWSResponse" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "nullable" : true, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_BaseUnlockAccessControlledDoorWSResponse" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "nullable" : true, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorForCurrentUserWSResponse" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorWSResponse" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" }, { "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_BulkProvisionPinCredentialsWSRequest" : { "type" : "object", "description" : "Request to bulk provision PIN credentials for multiple users.", "properties" : { "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", "example" : 1672531200, "minimum" : 0, "nullable" : true }, "notifyUsers" : { "type" : "boolean", "description" : "Whether to notify users about their new PIN credentials.", "example" : true, "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "default" : 5, "description" : "Length of PINs to be generated. Accepts length between 4 and 16. Default length is 5.", "example" : 5, "maximum" : 16, "minimum" : 4, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", "example" : 1640995200, "minimum" : 0, "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "example" : "59OcXLkFShWyHK3O2Fh2Ag", "nullable" : true }, "nullable" : true } } }, "Accesscontrol_credentials_BulkProvisionPinCredentialsWSResponse" : { "type" : "object", "description" : "Response containing the bulk provisioned PIN credentials and any failed users.", "properties" : { "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedUsers" : { "type" : "array", "description" : "List of user UUIDs for which PIN credential creation failed", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_BulkRotatePinCredentialsWSRequest" : { "type" : "object", "description" : "Request to bulk rotate PIN credentials for multiple users.", "properties" : { "credentialUuids" : { "type" : "array", "description" : "Set of credential uuids designated for PIN rotation.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", "example" : 1672531200, "minimum" : 0, "nullable" : true }, "notifyUsers" : { "type" : "boolean", "description" : "Whether to notify users about their rotated PIN credentials.", "example" : true, "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "default" : 5, "description" : "Length of PIN to be generated. Accepts length between 4 and 16. Default is 5.", "example" : 5, "maximum" : 16, "minimum" : 4, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", "example" : 1640995200, "minimum" : 0, "nullable" : true } }, "required" : [ "credentialUuids" ] }, "Accesscontrol_credentials_BulkRotatePinCredentialsWSResponse" : { "type" : "object", "description" : "Response containing the bulk rotated PIN credentials and any failed credentials.", "properties" : { "credentials" : { "type" : "array", "description" : "List of successfully rotated PIN credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSRequest" : { "type" : "object", "description" : "Request to create an access control credential by hex value and type.", "properties" : { "credentialType" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "hexValue" : { "type" : "string", "description" : "Hex value of the credential", "example" : "1234567890ABCDEF", "nullable" : true }, "littleEndian" : { "type" : "boolean", "description" : "Only needed when creating Wiegand credentials", "nullable" : true }, "numValueBits" : { "type" : "integer", "format" : "int32", "description" : "Only needed when creating Wiegand credentials", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSResponse" : { "type" : "object", "description" : "Response for access control credential creation by hex value and type.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateAppleWalletPassWSRequest" : { "type" : "object", "description" : "Request to create an Apple Wallet pass.", "properties" : { "credUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreatePinCredentialWSRequest" : { "type" : "object", "description" : "Request to create a PIN credential for a user.", "properties" : { "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when this credential expires. Credentials never expire if this value is left null.", "example" : 1672531200, "minimum" : 0, "nullable" : true }, "notifyUser" : { "type" : "boolean", "description" : "Whether to notify the user about the new PIN credential.", "example" : true, "nullable" : true }, "pinCode" : { "type" : "string", "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", "example" : "12345", "maxLength" : 16, "minLength" : 4, "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "default" : 5, "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. Default length is 5.", "example" : 5, "maximum" : 16, "minimum" : 4, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when this credential becomes active. Credentials activate immediately if this value is left null.", "example" : 1640995200, "minimum" : 0, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "userUuid" ] }, "Accesscontrol_credentials_CreatePinCredentialWSResponse" : { "type" : "object", "description" : "Response containing the created PIN credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSRequest" : { "type" : "object", "description" : "Request to create a Rhombus Secure CSN credential.", "properties" : { "credentialValue" : { "type" : "string", "description" : "Credential value", "example" : "123456789", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSResponse" : { "type" : "object", "description" : "Response for Rhombus Secure CSN credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateStandardCsnCredentialWSRequest" : { "type" : "object", "description" : "Request to create a standard CSN credential.", "properties" : { "credentialValue" : { "type" : "string", "description" : "Credential value", "example" : "123456789", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateStandardCsnCredentialWSResponse" : { "type" : "object", "description" : "Response for standard CSN credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSRequest" : { "type" : "object", "description" : "Request to create a 64-bit raw Wiegand credential.", "properties" : { "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "description" : "Credential value", "example" : "1234567890123456", "nullable" : true } } }, "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSResponse" : { "type" : "object", "description" : "Response for 64-bit raw Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegandCredentialWSRequest" : { "type" : "object", "description" : "Request to create a Wiegand credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int32", "description" : "Card number for the credential", "example" : 456, "nullable" : true }, "companyId" : { "type" : "integer", "format" : "int32", "description" : "Company ID used by HID CORP 1000", "example" : 1000, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "facilityCode" : { "type" : "integer", "format" : "int32", "description" : "Facility code for the credential", "example" : 123, "nullable" : true }, "siteCode" : { "type" : "integer", "format" : "int32", "description" : "Site code for the credential", "example" : 789, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "description" : "Final credential value used in RAW formats", "example" : "123456789", "nullable" : true }, "wiegandFormat" : { "$ref" : "#/components/schemas/WiegandFormatEnumType" } } }, "Accesscontrol_credentials_CreateWiegandCredentialWSResponse" : { "type" : "object", "description" : "Response for Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegandD10202CredentialWSRequest" : { "type" : "object", "description" : "Request to create a D10202 Wiegand credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int32", "description" : "Card number", "example" : 456789, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "facilityCode" : { "type" : "integer", "format" : "int32", "description" : "Facility code", "example" : 123, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateWiegandD10202CredentialWSResponse" : { "type" : "object", "description" : "Response for D10202 Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegandH10301CredentialWSRequest" : { "type" : "object", "description" : "Request to create a H10301 Wiegand credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int32", "description" : "Card number", "example" : 456789, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "facilityCode" : { "type" : "integer", "format" : "int32", "description" : "Facility code", "example" : 123, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateWiegandH10301CredentialWSResponse" : { "type" : "object", "description" : "Response for H10301 Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegandH10302CredentialWSRequest" : { "type" : "object", "description" : "Request to create a H10302 Wiegand credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int64", "description" : "Card number (35-bit, no facility code)", "example" : 456789, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateWiegandH10302CredentialWSResponse" : { "type" : "object", "description" : "Response for H10302 Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_CreateWiegandH10304CredentialWSRequest" : { "type" : "object", "description" : "Request to create a H10304 Wiegand credential.", "properties" : { "cardNumber" : { "type" : "integer", "format" : "int32", "description" : "Card number", "example" : 456789, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds (exclusive)", "example" : 1672531200, "nullable" : true }, "facilityCode" : { "type" : "integer", "format" : "int32", "description" : "Facility code", "example" : 123, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds (inclusive)", "example" : 1640995200, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_CreateWiegandH10304CredentialWSResponse" : { "type" : "object", "description" : "Response for H10304 Wiegand credential creation.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_DeleteAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to delete an access control credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_DeleteAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of an access control credential." }, "Accesscontrol_credentials_DeletePinCredentialWSRequest" : { "type" : "object", "description" : "Request to delete a PIN credential permanently from the system.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_DeletePinCredentialWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of a PIN credential.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to delete an unassigned access control credential.", "properties" : { "credentialHexValue" : { "type" : "string", "description" : "Hex value of the credential to delete", "example" : "1234567890ABCDEF", "nullable" : true } } }, "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of an unassigned access control credential." }, "Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSRequest" : { "type" : "object", "description" : "Request to find access control credentials by guest pass.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSResponse" : { "type" : "object", "description" : "Response containing access control credentials found for a specific guest pass.", "properties" : { "credentials" : { "type" : "array", "description" : "List of access control credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSRequest" : { "type" : "object", "description" : "Request to find access control credentials by organization.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSResponse" : { "type" : "object", "description" : "Response containing access control credentials found for an organization.", "properties" : { "credentials" : { "type" : "array", "description" : "List of access control credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByUserWSRequest" : { "type" : "object", "description" : "Request to find access control credentials by user.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByUserWSResponse" : { "type" : "object", "description" : "Response containing access control credentials found for a specific user.", "properties" : { "credentials" : { "type" : "array", "description" : "List of access control credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSRequest" : { "type" : "object", "description" : "Request to find access control credentials by multiple users.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" }, "userUuids" : { "type" : "array", "description" : "Set of user UUIDs to search for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSResponse" : { "type" : "object", "description" : "Response containing access control credentials mapped by user UUIDs.", "properties" : { "userCredentialsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of user UUIDs to their associated access control credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "description" : "Map of user UUIDs to their associated access control credentials", "nullable" : true } } }, "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSRequest" : { "type" : "object", "description" : "Request to find credential history by credential hex value.", "properties" : { "credentialHexValue" : { "type" : "string", "description" : "Hex value of the credential to search for", "example" : "1234567890ABCDEF", "nullable" : true }, "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSResponse" : { "type" : "object", "description" : "Response containing credential history found by credential hex value.", "properties" : { "credentials" : { "type" : "array", "description" : "List of credential history records", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSRequest" : { "type" : "object", "description" : "Request to find credential history by credential value.", "properties" : { "credentialType" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "credentialValue" : { "type" : "string", "description" : "Credential value to search for", "example" : "123456789", "nullable" : true }, "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSResponse" : { "type" : "object", "description" : "Response containing credential history found by credential value.", "properties" : { "credentials" : { "type" : "array", "description" : "List of credential history records", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindCredentialHistoryByUserWSRequest" : { "type" : "object", "description" : "Request to find credential history by user.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_FindCredentialHistoryByUserWSResponse" : { "type" : "object", "description" : "Response containing credential history found for a specific user.", "properties" : { "credentials" : { "type" : "array", "description" : "List of credential history records", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindCredentialHistoryWSRequest" : { "type" : "object", "description" : "Request to find credential history.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindCredentialHistoryWSResponse" : { "type" : "object", "description" : "Response containing credential history.", "properties" : { "credentials" : { "type" : "array", "description" : "List of credential history records", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_FindPinCredentialsByOrgWSRequest" : { "type" : "object", "description" : "Request to find PIN credentials in the organization with optional filtering.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindPinCredentialsByOrgWSResponse" : { "type" : "object", "description" : "Response containing a list of PIN credentials found in the organization.", "properties" : { "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_FindQrCodeCredentialsByOrgWSRequest" : { "type" : "object", "description" : "Request to find QR code credentials in the organization with optional filtering.", "properties" : { "filter" : { "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, "Accesscontrol_credentials_FindQrCodeCredentialsByOrgWSResponse" : { "type" : "object", "description" : "Response containing a list of QR code credentials found in the organization.", "properties" : { "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to find Rhombus Secure mobile credentials for current user." }, "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSResponse" : { "type" : "object", "description" : "Response for finding Rhombus Secure mobile credentials for current user.", "properties" : { "credentials" : { "type" : "array", "description" : "List of Rhombus Secure mobile credentials", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true } } }, "Accesscontrol_credentials_GetAccessControlCredentialDetailsWSRequest" : { "type" : "object", "description" : "Request to get an access control credential's details, including sensitive fields, by UUID.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_GetAccessControlCredentialDetailsWSResponse" : { "type" : "object", "description" : "Response containing an access control credential's details, including sensitive fields.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_GetAvailablePinCodeWSRequest" : { "type" : "object", "description" : "Request to get an available PIN code for creating a PIN credential.", "properties" : { "pinLength" : { "type" : "integer", "format" : "int32", "description" : "Length of PIN to be generated.", "example" : 5, "nullable" : true } }, "required" : [ "pinLength" ] }, "Accesscontrol_credentials_GetAvailablePinCodeWSResponse" : { "type" : "object", "description" : "Response containing an available PIN code for credential creation.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pinCode" : { "type" : "string", "description" : "The generated PIN code", "example" : "12345", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_GetPinCredentialDetailsWSRequest" : { "type" : "object", "description" : "Request to get detailed information about a PIN credential including sensitive data.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_GetPinCredentialDetailsWSResponse" : { "type" : "object", "description" : "Response containing detailed PIN credential information including sensitive data.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSRequest" : { "type" : "object", "description" : "Request to get Rhombus Secure CSN credential details.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSResponse" : { "type" : "object", "description" : "Response containing Rhombus Secure CSN credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSRequest" : { "type" : "object", "description" : "Request to get Rhombus Secure mobile app state stats for organization." }, "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSResponse" : { "type" : "object", "description" : "Response for getting Rhombus Secure mobile app state stats for organization.", "properties" : { "appStateStats" : { "$ref" : "#/components/schemas/RhombusSecureMobileAppStateStats" } } }, "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSRequest" : { "type" : "object", "description" : "Request to get standard CSN credential details.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSResponse" : { "type" : "object", "description" : "Response containing standard CSN credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_GetStaticQrCodeCredentialImageWSRequest" : { "type" : "object", "description" : "Request to render the scannable QR image for a single static QR code credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_GetStaticQrCodeCredentialImageWSResponse" : { "type" : "object", "description" : "Response containing a ready-to-display QR image for a static QR code credential.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "qrCode" : { "type" : "array", "description" : "The scannable QR code rendered as a PNG. Encodes the RHMB-tagged binary payload (header + format version + the token's raw bytes), not the token string.", "items" : { "type" : "string", "format" : "byte", "description" : "The scannable QR code rendered as a PNG. Encodes the RHMB-tagged binary payload (header + format version + the token's raw bytes), not the token string.", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" : { "type" : "string", "description" : "Enumeration of possible errors when provisioning mobile access control credentials.", "enum" : [ "USER_HAS_MAX_ALLOWED_CREDENTIALS" ] }, "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "errorType" : { "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "encodedPrivateKey" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to provision mobile access control credential for current user.", "properties" : { "appName" : { "type" : "string", "description" : "Name of the mobile app", "example" : "Rhombus Key", "nullable" : true }, "appNotifications" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" }, "appOS" : { "type" : "string", "description" : "Operating system of the mobile device", "example" : "iOS 15.0", "nullable" : true }, "appVersion" : { "type" : "string", "description" : "Version of the mobile app", "example" : "1.2.3", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/MobileTokenOSEnum" }, "deviceModel" : { "type" : "string", "description" : "Model of the mobile device", "example" : "iPhone 13", "nullable" : true }, "installationId" : { "type" : "string", "description" : "Installation ID of the mobile app", "example" : "abc123def456", "nullable" : true }, "tapToUnlock" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" }, "waveToUnlock" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" } } }, "Accesscontrol_credentials_RevokeAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to revoke an access control credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_RevokeAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response containing the revoked access control credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_RevokePinCredentialWSRequest" : { "type" : "object", "description" : "Request to revoke a PIN credential, making it inactive.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_RevokePinCredentialWSResponse" : { "type" : "object", "description" : "Response indicating successful revocation of a PIN credential.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to revoke Rhombus Secure mobile credential for current user.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSResponse" : { "type" : "object", "description" : "Response for revoking Rhombus Secure mobile credential for current user." }, "Accesscontrol_credentials_RotatePinCredentialWSRequest" : { "type" : "object", "description" : "Request to rotate a PIN credential with a new value.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when this credential expires. If left null, copies the end date from the previous PIN.", "example" : 1672531200, "minimum" : 0, "nullable" : true }, "notifyUser" : { "type" : "boolean", "description" : "Whether to notify the user about their rotated PIN credential.", "example" : true, "nullable" : true }, "pinCode" : { "type" : "string", "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", "example" : "12345", "maxLength" : 16, "minLength" : 4, "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. If left null, the generated PIN will have the same length as the previous PIN.", "example" : 5, "maximum" : 16, "minimum" : 4, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when this credential becomes active. If left null, copies the start date from the previous PIN.", "example" : 1640995200, "minimum" : 0, "nullable" : true } }, "required" : [ "credentialUuid" ] }, "Accesscontrol_credentials_RotatePinCredentialWSResponse" : { "type" : "object", "description" : "Response containing the rotated PIN credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_SuspendAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to suspend an access control credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_SuspendAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response containing the suspended access control credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSRequest" : { "type" : "object", "description" : "Request to unsuspend an access control credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSResponse" : { "type" : "object", "description" : "Response containing the unsuspended access control credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSRequest" : { "type" : "object", "description" : "Request to update the note field of an access control credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "description" : "Note to be associated with the credential. Max length is 250 characters.", "example" : "Employee badge", "nullable" : true } } }, "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSResponse" : { "type" : "object", "description" : "Response for updating the note field of an access control credential.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UpdatePinCredentialWSRequest" : { "type" : "object", "description" : "Request to update a PIN credential with new start and end dates.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_credentials_UpdatePinCredentialWSResponse" : { "type" : "object", "description" : "Response containing the updated PIN credential details.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to update Rhombus Key mobile app state for current user.", "properties" : { "appName" : { "type" : "string", "description" : "Name of the mobile app", "example" : "Rhombus Key", "nullable" : true }, "appNotifications" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" }, "appOS" : { "type" : "string", "description" : "Operating system of the mobile device", "example" : "iOS 15.0", "nullable" : true }, "appVersion" : { "type" : "string", "description" : "Version of the mobile app", "example" : "1.2.3", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/MobileTokenOSEnum" }, "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceModel" : { "type" : "string", "description" : "Model of the mobile device", "example" : "iPhone 13", "nullable" : true }, "tapToUnlock" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" }, "waveToUnlock" : { "$ref" : "#/components/schemas/RhombusSecureMobileFeature" } } }, "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSResponse" : { "type" : "object", "description" : "Response for updating Rhombus Key mobile app state for current user.", "properties" : { "appState" : { "$ref" : "#/components/schemas/RhombusSecureMobileAppState" } } }, "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSRequest" : { "type" : "object", "description" : "Request to update a Rhombus Secure CSN credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSResponse" : { "type" : "object", "description" : "Response containing the updated Rhombus Secure CSN credential.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSRequest" : { "type" : "object", "description" : "Request to update a Rhombus Secure mobile credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSResponse" : { "type" : "object", "description" : "Response containing the updated Rhombus Secure mobile credential.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UpdateStandardCsnCredentialWSRequest" : { "type" : "object", "description" : "Request to update a standard CSN credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_credentials_UpdateStandardCsnCredentialWSResponse" : { "type" : "object", "description" : "Response containing the updated standard CSN credential.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_credentials_UpdateWiegandCredentialWSRequest" : { "type" : "object", "description" : "Request to update a Wiegand credential.", "properties" : { "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_credentials_UpdateWiegandCredentialWSResponse" : { "type" : "object", "description" : "Response containing the updated Wiegand credential.", "properties" : { "credential" : { "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSRequest" : { "type" : "object", "description" : "Request to create a new door schedule exception.", "properties" : { "exception" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" } } }, "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSResponse" : { "type" : "object", "description" : "Response containing the created door schedule exception.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exception" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSRequest" : { "type" : "object", "description" : "Request to delete a specific door schedule exception by UUID.", "properties" : { "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSResponse" : { "type" : "object", "description" : "Response confirming the deletion of a door schedule exception.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSRequest" : { "type" : "object", "description" : "Request to search for door schedule exceptions for a specific door with optional date range filtering.", "properties" : { "dateRangeFilter" : { "$ref" : "#/components/schemas/DateRangeFilter" }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSResponse" : { "type" : "object", "description" : "Response containing a list of door schedule exceptions found for a specific door.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exceptions" : { "type" : "array", "description" : "List of door schedule exceptions found for the specified door.", "items" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSRequest" : { "type" : "object", "description" : "Request to search for door schedule exceptions for a specific location with optional date range filtering.", "properties" : { "dateRangeFilter" : { "$ref" : "#/components/schemas/DateRangeFilter" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSResponse" : { "type" : "object", "description" : "Response containing a list of door schedule exceptions found for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exceptions" : { "type" : "array", "description" : "List of door schedule exceptions found for the specified location.", "items" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSRequest" : { "type" : "object", "description" : "Request to search for door schedule exceptions with optional date range filtering.", "properties" : { "dateRangeFilter" : { "$ref" : "#/components/schemas/DateRangeFilter" } } }, "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSResponse" : { "type" : "object", "description" : "Response containing a list of door schedule exceptions found in the search.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exceptions" : { "type" : "array", "description" : "List of door schedule exceptions found in the search.", "items" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_GetDoorScheduleExceptionWSRequest" : { "type" : "object", "description" : "Request to retrieve a specific door schedule exception by UUID.", "properties" : { "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_doorexception_GetDoorScheduleExceptionWSResponse" : { "type" : "object", "description" : "Response containing the requested door schedule exception.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exception" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSRequest" : { "type" : "object", "description" : "Request to update an existing door schedule exception.", "properties" : { "exception" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" } } }, "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSResponse" : { "type" : "object", "description" : "Response containing the updated door schedule exception and license information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "exception" : { "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of door UUIDs with expired access control licenses.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of door UUIDs with unassigned access control licenses.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSRequest" : { "type" : "object", "description" : "Request to apply door auth first-in state to all doors in a first-in settings group.", "properties" : { "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSResponse" : { "type" : "object", "description" : "Response containing the updated location first-in settings after applying door auth first-in group state.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSRequest" : { "type" : "object", "description" : "Request to apply door auth first-in state to a specific door.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSResponse" : { "type" : "object", "description" : "Response containing the updated door after applying door auth first-in state.", "properties" : { "door" : { "$ref" : "#/components/schemas/AccessControlledDoorType" } } }, "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSRequest" : { "type" : "object", "description" : "Request to apply door schedule first-in state to all doors in a first-in settings group.", "properties" : { "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSResponse" : { "type" : "object", "description" : "Response containing the updated location first-in settings after applying door schedule first-in group state.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSRequest" : { "type" : "object", "description" : "Request to apply door schedule first-in state to a specific door.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSResponse" : { "type" : "object", "description" : "Response containing the updated door after applying door schedule first-in state.", "properties" : { "door" : { "$ref" : "#/components/schemas/AccessControlledDoorType" } } }, "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSRequest" : { "type" : "object", "description" : "Request to apply access schedule first-in state to a specific elevator landing.", "properties" : { "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSResponse" : { "type" : "object", "description" : "Response containing the updated elevator landing after applying access schedule first-in state.", "properties" : { "elevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" } } }, "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSRequest" : { "type" : "object", "description" : "Request to apply auth first-in state to a specific elevator landing.", "properties" : { "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSResponse" : { "type" : "object", "description" : "Response containing the updated elevator landing after applying auth first-in state.", "properties" : { "elevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" } } }, "Accesscontrol_firstin_CreateLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to create new location first-in settings.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_CreateLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the created location first-in settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to delete specific location first-in settings by UUID.", "properties" : { "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the deleted location first-in settings.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSRequest" : { "type" : "object", "description" : "Request to search for location first-in settings for a specific location with pagination support.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSResponse" : { "type" : "object", "description" : "Response containing a list of location first-in settings found for the specified location with pagination information.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, "settingsList" : { "type" : "array", "description" : "List of location first-in settings found for the specified location.", "items" : { "$ref" : "#/components/schemas/LocationFirstInSettings" }, "nullable" : true } } }, "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSRequest" : { "type" : "object", "description" : "Request to search for location first-in settings across the organization with pagination support.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSResponse" : { "type" : "object", "description" : "Response containing a list of location first-in settings found in the organization with pagination information.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, "settingsList" : { "type" : "array", "description" : "List of location first-in settings found in the organization.", "items" : { "$ref" : "#/components/schemas/LocationFirstInSettings" }, "nullable" : true } } }, "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSRequest" : { "type" : "object", "description" : "Request to retrieve location first-in settings for a specific door.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSResponse" : { "type" : "object", "description" : "Response containing the location first-in settings for the specified door.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_GetLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to retrieve specific location first-in settings by UUID.", "properties" : { "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_firstin_GetLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the requested location first-in settings.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to remove a door from its assigned location first-in settings.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the updated location first-in settings after removing the door.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to remove an elevator landing from its assigned location first-in settings.", "properties" : { "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the updated location first-in settings after removing the elevator landing.", "properties" : { "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSRequest" : { "type" : "object", "description" : "Request to update existing location first-in settings with selective field updates.", "properties" : { "description" : { "type" : "string", "description" : "Optional description for the first-in settings.", "nullable" : true }, "doorAuthRequirementEnabled" : { "type" : "boolean", "description" : "Optional flag to enable/disable door auth requirement.", "nullable" : true }, "doorScheduleRequirementEnabled" : { "type" : "boolean", "description" : "Optional flag to enable/disable door schedule requirement.", "nullable" : true }, "doorUuids" : { "type" : "array", "description" : "Optional sorted set of door UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "elevatorLandingUuids" : { "type" : "array", "description" : "Optional sorted set of elevator landing UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "groupUuids" : { "type" : "array", "description" : "Optional sorted set of group UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "name" : { "type" : "string", "description" : "Optional name for the first-in settings.", "nullable" : true }, "resets" : { "type" : "array", "description" : "Optional list of first-in reset configurations.", "items" : { "$ref" : "#/components/schemas/BaseFirstInReset" }, "nullable" : true }, "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuids" : { "type" : "array", "description" : "Optional sorted set of user UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSResponse" : { "type" : "object", "description" : "Response containing the updated location first-in settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "expiredACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "settings" : { "$ref" : "#/components/schemas/LocationFirstInSettings" }, "unassignedACDLicensesDoorUuids" : { "type" : "array", "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_guestpass_CreateGuestPassWSRequest" : { "type" : "object", "description" : "Request to create a guest pass with N access periods (each its own door/landing set and absolute intervals), plus any credentials to mint or assign in the same operation.", "properties" : { "accessPeriods" : { "type" : "array", "description" : "Access periods for the pass. The pass window must span at most 7 days and start within 90 days.", "items" : { "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" }, "nullable" : true }, "createWithExistingCredentials" : { "type" : "array", "description" : "Hex values of existing, currently-unassigned credentials to assign to the new guest pass. Each entry is validated up front; missing-credential / already-assigned aborts the create with rollback.", "items" : { "$ref" : "#/components/schemas/ExistingGuestPassCredentialAssignment" }, "nullable" : true }, "createWithNewCredentials" : { "type" : "array", "description" : "Polymorphic specs for credentials to be minted and bound to the new guest pass. Each entry is discriminated on the 'type' field (currently only PIN_CODE is supported). All entries are validated up front; any invalid entry aborts the create with rollback.", "items" : { "$ref" : "#/components/schemas/NewGuestPassCredentialSpec" }, "nullable" : true }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "sendEmail" : { "type" : "boolean", "description" : "Email the guest their PIN and QR code once the pass is created. Needs a PLAIN pass with a guestEmail; the request is rejected otherwise. If the send fails the pass is still created, and emailSent on the response is false.", "nullable" : true } } }, "Accesscontrol_guestpass_CreateGuestPassWSResponse" : { "type" : "object", "description" : "Created guest pass plus any credentials minted/assigned to it in the same call. createdNewCredentials and assignedExistingCredentials are in the order of the corresponding request lists.", "properties" : { "assignedExistingCredentials" : { "type" : "array", "description" : "Existing credentials newly assigned to the pass as part of this create, in the order of CreateGuestPassWSRequest.createWithExistingCredentials.", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "createdNewCredentials" : { "type" : "array", "description" : "Credentials minted as part of this create, in the order of CreateGuestPassWSRequest.createWithNewCredentials. For PIN_CODE entries the returned credential carries the (possibly server-generated) PIN value so the caller can surface it to the guest.", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "emailSent" : { "type" : "boolean", "description" : "Whether the guest was emailed their credentials. False when sendEmail wasn't set, when the pass has no PIN or QR code to send, or when the send failed.", "nullable" : true }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_DeleteGuestPassWSRequest" : { "type" : "object", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_DeleteGuestPassWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_ExpireGuestPassWSRequest" : { "type" : "object", "description" : "Retire a guest pass early, revoking its access. This is the normal operator retirement action.", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_ExpireGuestPassWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_FindGuestPassesByLocationWSRequest" : { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "startAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_guestpass_FindGuestPassesByOrgWSRequest" : { "type" : "object", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "startAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_guestpass_FindGuestPassesByPrincipalWSRequest" : { "type" : "object", "properties" : { "principalId" : { "type" : "string", "nullable" : true }, "principalType" : { "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" }, "startAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "startBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Accesscontrol_guestpass_FindGuestPassesWSResponse" : { "type" : "object", "properties" : { "guestPasses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_guestpass_GetGuestPassFullWSRequest" : { "type" : "object", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_GetGuestPassFullWSResponse" : { "type" : "object", "properties" : { "credentials" : { "type" : "array", "description" : "Credentials assigned to the pass.", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_GetGuestPassWSRequest" : { "type" : "object", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_GetGuestPassWSResponse" : { "type" : "object", "description" : "The bare guest pass. Use getGuestPassFull for the materialized access periods + credentials.", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_ResendGuestPassEmailWSRequest" : { "type" : "object", "description" : "Email a guest pass's PIN and QR code to its guest again.", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_ResendGuestPassEmailWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_SuspendGuestPassWSRequest" : { "type" : "object", "description" : "Pause a guest pass: flips lifecycle to SUSPENDED and suspends its credentials, leaving grants + schedule intact. Reversible via unsuspendGuestPass.", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_SuspendGuestPassWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_UnsuspendGuestPassWSRequest" : { "type" : "object", "description" : "Resume a paused guest pass: flips lifecycle back to ACTIVE and unsuspends its credentials. Rejected if the pass is no longer SUSPENDED (e.g. already expired).", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_UnsuspendGuestPassWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_UpdateGuestPassNoteWSRequest" : { "type" : "object", "description" : "Update only the operator note on a guest pass. Lifecycle-independent -- allowed even after the pass is EXPIRED or ARCHIVED. Empty note clears it.", "properties" : { "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_guestpass_UpdateGuestPassNoteWSResponse" : { "type" : "object", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_guestpass_UpdateGuestPassWSRequest" : { "type" : "object", "description" : "Update a guest pass's access. accessPeriodUpdates create/update/delete individual access periods. The note is edited via updateGuestPassNote.", "properties" : { "accessPeriodUpdates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationGuestPassAccessPeriodUpdate" }, "nullable" : true }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_guestpass_UpdateGuestPassWSResponse" : { "type" : "object", "description" : "Updated guest pass plus its access periods as they stand after the update.", "properties" : { "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSRequest" : { "type" : "object", "description" : "Request to activate lockdown for a specific location via Rhombus Key with optional optimistic locking.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuids" : { "type" : "array", "description" : "Set of lockdown plan UUIDs to activate for the location.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSResponse" : { "type" : "object", "description" : "Response containing the result of activating lockdown for a location via Rhombus Key.", "properties" : { "result" : { "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest" : { "type" : "object", "description" : "Request to activate lockdown for a specific location with optional optimistic locking.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuids" : { "type" : "array", "description" : "Set of lockdown plan UUIDs to activate for the location.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse" : { "type" : "object", "description" : "Response containing the result of activating lockdown for a location.", "properties" : { "result" : { "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSRequest" : { "type" : "object", "description" : "Request to activate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", "properties" : { "lockdownPlansByLocation" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", "nullable" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", "nullable" : true } }, "required" : [ "lockdownPlansByLocation" ] }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse" : { "type" : "object", "description" : "Response containing the results of activating lockdown for multiple locations via Rhombus key.\n", "properties" : { "lockdownResults" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" }, "description" : "The results of the lockdown activation attempt per location.", "nullable" : true } } }, "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" : { "type" : "object", "description" : "The results of the lockdown activation attempt per location.", "properties" : { "info" : { "type" : "string", "description" : "Additional info regarding the outcome of the activation attempt.", "nullable" : true }, "result" : { "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest" : { "type" : "object", "description" : "Request to create a new location lockdown plan.", "properties" : { "lockdownPlan" : { "$ref" : "#/components/schemas/LocationLockdownPlanType" } } }, "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse" : { "type" : "object", "description" : "Response containing the created location lockdown plan.", "properties" : { "lockdownPlan" : { "$ref" : "#/components/schemas/LocationLockdownPlanType" } } }, "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest" : { "type" : "object", "description" : "Request to create a new lockdown rule for a specific location.", "properties" : { "rule" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" } }, "required" : [ "rule" ] }, "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse" : { "type" : "object", "description" : "Response containing the UUID of the created lockdown rule.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSRequest" : { "type" : "object", "description" : "Request to deactivate lockdown for a specific location via Rhombus Key with optional optimistic locking.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSResponse" : { "type" : "object", "description" : "Response containing the result of deactivating lockdown for a location via Rhombus Key.", "properties" : { "result" : { "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest" : { "type" : "object", "description" : "Request to deactivate lockdown for a specific location with optional optimistic locking.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse" : { "type" : "object", "description" : "Response containing the result of deactivating lockdown for a location.", "properties" : { "result" : { "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSRequest" : { "type" : "object", "description" : "Request to deactivate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", "properties" : { "locationUuids" : { "type" : "array", "description" : "Set of location UUIDs to deactivate lockdown for.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", "nullable" : true } }, "required" : [ "locationUuids" ] }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse" : { "type" : "object", "description" : "Response containing the results of deactivating lockdown for multiple locations via Rhombus key.\n", "properties" : { "lockdownResults" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" }, "description" : "The results of the lockdown activation attempt per location.", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" : { "type" : "object", "description" : "The results of the lockdown activation attempt per location.", "properties" : { "info" : { "type" : "string", "description" : "Additional info regarding the outcome of the deactivation attempt.", "nullable" : true }, "result" : { "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest" : { "type" : "object", "description" : "Request to delete the lockdown state tracking for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of location lockdown state." }, "Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest" : { "type" : "object", "description" : "Request to delete a specific lockdown plan by UUID.", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse" : { "type" : "object", "description" : "Response confirming the deletion of a lockdown plan.", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest" : { "type" : "object", "description" : "Request to delete a specific lockdown rule for a location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of a lockdown rule.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_lockdownplan_DeleteLockdownRuleForPlanWSRequest" : { "type" : "object", "description" : "Request to delete a specific lockdown rule owned by a lockdown plan.", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "lockdownPlanUuid", "ruleUuid" ] }, "Accesscontrol_lockdownplan_DeleteLockdownRuleForPlanWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of a plan-owned lockdown rule.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest" : { "type" : "object", "description" : "Request to disable test mode for lockdown at a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse" : { "type" : "object", "description" : "Response containing the updated lockdown state after disabling test mode.", "properties" : { "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest" : { "type" : "object", "description" : "Request to enable test mode for lockdown at a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse" : { "type" : "object", "description" : "Response containing the updated lockdown state after enabling test mode.", "properties" : { "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" : { "type" : "object", "description" : "External representation of a lockdown plan rule configuration.", "properties" : { "action" : { "$ref" : "#/components/schemas/RuleActionType" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleFilters" : { "$ref" : "#/components/schemas/RuleFilterType" }, "ruleName" : { "type" : "string", "description" : "The name of the lockdown rule.", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "triggerActivity" : { "$ref" : "#/components/schemas/ActivityEnum" } }, "required" : [ "action", "locationUuid", "ruleName", "triggerActivity" ] }, "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest" : { "type" : "object", "description" : "Request to find lockdown events for a specific location with optional time filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Limits the number of returned events to the latest LIMIT events", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse" : { "type" : "object", "description" : "Response containing a list of lockdown events for a specific location.", "properties" : { "events" : { "type" : "array", "description" : "List of lockdown events found for the specified location.", "items" : { "$ref" : "#/components/schemas/BaseLockdownStateEventType" }, "nullable" : true } } }, "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest" : { "type" : "object", "description" : "Request to find location lockdown states with optional filtering.", "properties" : { "stateFilter" : { "type" : "array", "description" : "Optional filter to limit results to specific lockdown states.", "items" : { "$ref" : "#/components/schemas/LocationLockdownStateEnumType" }, "nullable" : true } } }, "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse" : { "type" : "object", "description" : "Response containing a list of location lockdown states.", "properties" : { "states" : { "type" : "array", "description" : "List of location lockdown states found for the organization.", "items" : { "$ref" : "#/components/schemas/LocationLockdownStateType" }, "nullable" : true } } }, "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest" : { "type" : "object", "description" : "Request to search for lockdown plans for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse" : { "type" : "object", "description" : "Response containing a list of lockdown plans found for the specified location.", "properties" : { "lockdownPlans" : { "type" : "array", "description" : "List of lockdown plans found for the specified location.", "items" : { "$ref" : "#/components/schemas/BaseLockdownPlanType" }, "nullable" : true } } }, "Accesscontrol_lockdownplan_FindLockdownPlansWSRequest" : { "type" : "object", "description" : "Request to search for lockdown plans across the organization." }, "Accesscontrol_lockdownplan_FindLockdownPlansWSResponse" : { "type" : "object", "description" : "Response containing a list of lockdown plans found in the organization.", "properties" : { "lockdownPlans" : { "type" : "array", "description" : "List of lockdown plans found in the organization.", "items" : { "$ref" : "#/components/schemas/BaseLockdownPlanType" }, "nullable" : true } } }, "Accesscontrol_lockdownplan_GetLockdownPlanWSRequest" : { "type" : "object", "description" : "Request to retrieve a specific lockdown plan by UUID.", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_GetLockdownPlanWSResponse" : { "type" : "object", "description" : "Response containing the requested lockdown plan.", "properties" : { "lockdownPlan" : { "$ref" : "#/components/schemas/BaseLockdownPlanType" } } }, "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve all lockdown rules for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse" : { "type" : "object", "description" : "Response containing a list of lockdown rules for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of lockdown rules configured for the specified location.", "items" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_lockdownplan_GetLockdownRulesForPlanWSRequest" : { "type" : "object", "description" : "Request to retrieve all lockdown rules for a specific lockdown plan.", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "lockdownPlanUuid" ] }, "Accesscontrol_lockdownplan_GetLockdownRulesForPlanWSResponse" : { "type" : "object", "description" : "Response containing a list of lockdown rules for a specific lockdown plan.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of lockdown rules configured for the specified lockdown plan.", "items" : { "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest" : { "type" : "object", "description" : "Request to retrieve an existing lockdown state or create one for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse" : { "type" : "object", "description" : "Response containing the lockdown state for the specified location.", "properties" : { "state" : { "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest" : { "type" : "object", "description" : "Request to update an existing location lockdown plan with selective field updates.", "properties" : { "activationPlan" : { "$ref" : "#/components/schemas/LockdownActivationPlanType" }, "deactivationPlan" : { "$ref" : "#/components/schemas/LockdownDeactivationPlanType" }, "defaultLockdownState" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "doorLockdownStateMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "physicalAccess" : { "$ref" : "#/components/schemas/LockdownPhysicalAccessType" }, "testPlan" : { "$ref" : "#/components/schemas/LockdownTestPlanType" } } }, "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse" : { "type" : "object", "description" : "Response containing the updated location lockdown plan.", "properties" : { "lockdownPlan" : { "$ref" : "#/components/schemas/LocationLockdownPlanType" } } }, "Accesscontrol_qr_GenerateQRAccessCodeWSRequest" : { "type" : "object", "description" : "Request to generate a QR access code.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "auditPrincipal" : { "type" : "string", "nullable" : true }, "validDurationSec" : { "type" : "integer", "format" : "int32", "description" : "Valid duration in seconds", "example" : 300, "nullable" : true } } }, "Accesscontrol_qr_GenerateQRAccessCodeWSResponse" : { "type" : "object", "description" : "Response for QR access code generation.", "properties" : { "accessTokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "qrCode" : { "type" : "array", "description" : "QR code as PNG byte array", "items" : { "type" : "string", "format" : "byte", "description" : "QR code as PNG byte array", "nullable" : true }, "nullable" : true } } }, "Accesscontrol_qr_GetQRAccessCodesWSRequest" : { "type" : "object", "description" : "Request to get QR access codes." }, "Accesscontrol_qr_GetQRAccessCodesWSResponse" : { "type" : "object", "description" : "Response for getting QR access codes.", "properties" : { "qrAccessCodes" : { "type" : "array", "description" : "List of QR access codes", "items" : { "$ref" : "#/components/schemas/Accesscontrol_qr_QRAccessCodeType" }, "nullable" : true } } }, "Accesscontrol_qr_QRAccessCodeType" : { "type" : "object", "description" : "QR code access configuration for a specific door.", "properties" : { "accesTokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "auditPrincipal" : { "type" : "string", "description" : "Information about the user of the QR code so that audit events can be tracked.", "nullable" : true }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "expirationTimeSec" : { "type" : "integer", "format" : "int64", "description" : "The expiration time of this QR code in seconds since epoch.", "nullable" : true } } }, "ActivateLocationLockdownActionRecordType" : { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "succeeded" : { "type" : "boolean", "nullable" : true } } }, "ActivateLocationLockdownActionType" : { "type" : "object", "properties" : { "locationLockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ActivityEnum" : { "type" : "string", "enum" : [ "SOUND_LOUD", "SOUND_GUN_SHOT", "TAMPER", "VISUAL_TAMPER", "MOTION_TAMPER", "MOTION", "MOTION_HUMAN", "MOTION_CAR", "MOTION_ANIMAL", "MOTION_PACKAGE", "PACKAGE_ARRIVED", "PACKAGE_DEPARTED", "FACE", "FACE_IDENTIFIED", "FACE_UNIDENTIFIED", "FACE_BLACKLISTED", "FACE_ALERT", "POSE_ANOMALOUS", "POSE_FALL", "LICENSEPLATE", "LICENSEPLATE_IDENTIFIED", "LICENSEPLATE_UNIDENTIFIED", "LICENSEPLATE_ALERT", "LICENSEPLATE_BLACKLISTED", "LICENSEPLATE_TRUSTED", "PEOPLECOUNT_HIGH", "PEOPLECOUNT_HIGH_RESET", "PEOPLECOUNT_LOW", "PEOPLECOUNT_LOW_RESET", "HUMAN_ENTER", "HUMAN_EXIT", "CAR_ENTER", "CAR_EXIT", "TEMPERATURE_EXCEEDED_HIGH", "TEMPERATURE_EXCEEDED_LOW", "HUMIDITY_EXCEEDED_HIGH", "HUMIDITY_EXCEEDED_LOW", "PM25_EXCEEDED_HIGH", "TVOC_EXCEEDED_HIGH", "ETOH_EXCEEDED_HIGH", "IAQ_EXCEEDED_HIGH", "CO2_EXCEEDED_HIGH", "CO2_EXCEEDED_LOW", "PROBE_TEMPERATURE_EXCEEDED_HIGH", "PROBE_TEMPERATURE_EXCEEDED_LOW", "PROBE_DISCONNECTED", "PROBE_CONNECTED", "HEAT_INDEX_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_LOW", "PM10_EXCEEDED_HIGH", "PM40_EXCEEDED_HIGH", "PM100_EXCEEDED_HIGH", "VOC_IDX_EXCEEDED_HIGH", "NOX_IDX_EXCEEDED_HIGH", "FORMALDEHYDE_EXCEEDED_HIGH", "CARBON_MONOXIDE_EXCEEDED_HIGH", "AQI_EXCEEDED_HIGH", "DOOR_AJAR", "DOOR_OPENED", "DOOR_CLOSED", "BUTTON_SINGLE_PRESSED", "BUTTON_DOUBLE_PRESSED", "BUTTON_LONG_PRESSED", "TAG_ARRIVED", "TAG_DEPARTED", "TAG_MOVED", "TAG_POSITIONING_CHANGED", "TAG_BOUNDARY_INGRESS", "TAG_BOUNDARY_EGRESS", "TAG_PANIC", "BADGE_AUTHORIZED", "BADGE_UNAUTHORIZED", "BADGE_UNAUTHORIZED_V2", "BADGE_AJAR", "BADGE_MANUAL", "BADGE_FORCED_OPEN", "BADGE_LOCKDOWN", "BADGE_REQUEST_TO_EXIT", "BADGE_DURESS", "BADGE_SECURITY_BREACH", "BADGE_TAMPER", "BADGE_FACE_MISMATCH", "POS_ORDER", "GUN_DETECT_EVENT", "IOT_SOUND_AGGRESSION", "IOT_SOUND_HELP", "IOT_AIR_CO", "IOT_AIR_CO2", "IOT_AIR_MASKING", "IOT_AIR_THC", "IOT_AIR_VAPE", "IOT_AIR_VOC", "IOT_AIR_TEMP", "IOT_TAMPER", "IOT_GUNSHOT", "IOT_BUTTON_SINGLE_CLICK", "IOT_BUTTON_DOUBLE_CLICK", "IOT_BUTTON_HOLD", "IOT_PANIC_BUTTON_TRIGGERED", "AUDIO_SOUND_SIGNIFICANT", "AUDIO_SOUND_LOUD", "AUDIO_SOUND_ABUSIVE", "AUDIO_SOUND_GREETING", "AUDIO_SOUND_HELP", "AUDIO_SOUND_GUN", "AUDIO_SOUND_GLASS_BREAK", "AUDIO_SOUND_ALARM_SMOKE_FIRE", "AUDIO_SOUND_ALARM_CARBON_MONOXIDE", "AUDIO_SOUND_SIREN", "CLIMATE_VOC", "CLIMATE_VAPE", "CLIMATE_SMOKE", "CLIMATE_THC", "CLIMATE_CO2", "CLIMATE_ETOH", "CLIMATE_PM25", "CLIMATE_IAQ", "CLIMATE_LEAK", "SOUND_AGGRESSION", "SOUND_HELP", "AIR_CO", "AIR_CO2", "AIR_MASKING", "AIR_THC", "AIR_VAPE", "AIR_VOC", "MASK_MISSING", "HELMET_MISSING", "GLOVES_MISSING", "PIR_OCCUPIED", "PIR_MOVEMENT", "PIR_VACANT", "CUSTOM", "VISITOR_ARRIVED", "VISITOR_DEPARTED", "AC_DR_CONNECTED", "AC_DR_DISCONNECTED", "AC_DPI_DOOR_OPEN", "AC_DPI_DOOR_CLOSED", "AC_DPI_DOOR_AJAR", "AC_DPI_DOOR_FORCED_OPEN", "AC_DSR_UNLOCKED", "AC_DSR_LOCKED", "AC_DB_TRIGGERED", "AC_PANIC_BUTTON_TRIGGERED", "AC_REMOTE_UNLOCK", "AC_BADGE_AUTHORIZED", "AC_BADGE_UNAUTHORIZED", "AC_BADGE_FACE_MISMATCH", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_LOCKDOWN_PLAN_SWITCHED", "AC_TAMPER_PROX", "AC_TAMPER_ACCEL", "AC_TAMPER_SWITCH", "AC_GR_ACTIVE", "AC_GR_INACTIVE", "AC_GI_ACTIVE", "AC_GI_INACTIVE", "AC_REX_ACTIVE", "AC_REX_INACTIVE", "AC_APERIO_DEVICE_DISCONNECTED", "AC_APERIO_DEVICE_CONNECTED", "AC_APERIO_DEVICE_REBOOT", "AC_APERIO_DEVICE_TAMPER", "AC_APERIO_LOW_BATTERY", "AC_APERIO_FLAT_BATTERY", "AC_APERIO_OK_BATTERY", "AC_SCHLAGE_GW_DISCONNECTED", "AC_SCHLAGE_GW_CONNECTED", "AC_SCHLAGE_APM_DISCONNECTED", "AC_SCHLAGE_APM_CONNECTED", "AC_SCHLAGE_LOW_BATTERY", "AC_SCHLAGE_CRITICAL_BATTERY", "AC_SCHLAGE_OK_BATTERY", "POWER_SWITCH_BATTERY", "POWER_SWITCH_PRIMARY", "AI_SEARCH_MATCH", "AI_SEARCH_MATCH_PERSON_SMOKING", "AI_SEARCH_MATCH_PERSON_ON_PHONE", "AI_SEARCH_MATCH_PERSON_FALLING", "CUSTOM_LLM_BOOLEAN_TRUE", "CUSTOM_LLM_BOOLEAN_FALSE", "CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW", "CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH", "ALM_AUTHORITIES_CONTACTED", "ALM_MONITORING_ENABLED", "ALM_MONITORING_DISABLED", "ALM_MONITORING_SETTINGS_CHANGE", "ALM_THREAT_CASE_CLOSED", "ALM_THREAT_DETECTED", "ALM_MONITORING_EVENT_DETECTED", "ROBOT_DOG_DETECTED", "ROBOT_ARRIVED_AT_WAYPOINT", "ROBOT_ARRIVED_AT_POSE", "ROBOT_WAITING_AT_POSE", "ROBOT_MANUAL_CMD_VEL", "ROBOT_MANUAL_ACTION", "ROBOT_MANUAL_POSTURE", "ROBOT_NAVIGATE_TO_POSE_START", "ROBOT_NAVIGATE_TO_POSE_END", "ROBOT_NAVIGATE_TO_HOME_START", "ROBOT_NAVIGATE_TO_HOME_END", "ROBOT_NAVIGATE_TO_WAYPOINT_START", "ROBOT_NAVIGATE_TO_WAYPOINT_END", "ROBOT_ROUTE_RUN_START", "ROBOT_ROUTE_RUN_END", "ROBOT_LOW_BATTERY_DOCKING", "ROBOT_IDLE_DOCKING", "ROBOT_EMERGENCY", "LOITER_HUMAN", "INACTIVITY_HUMAN", "INACTIVITY_CAR", "GROUP_ENTRY", "ONGUARD_BADGE_AUTHORIZED", "ONGUARD_BADGE_ANOMALY", "ONGUARD_NO_ENTRY_MADE", "ELEMENTS_BADGE_AUTHORIZED", "ELEMENTS_BADGE_ANOMALY", "ELEMENTS_NO_ENTRY_MADE", "NETBOX_BADGE_AUTHORIZED", "NETBOX_BADGE_ANOMALY", "NETBOX_NO_ENTRY_MADE", "THERMAL_TEMPERATURE_ALARM", "THERMAL_TEMPERATURE_WARNING", "THERMAL_FIRE_DETECTED", "THERMAL_SMOKING_DETECTED", "THERMAL_FIRE_VERIFIED", "THERMAL_HEAT_NO_THREAT", "THERMAL_VISUAL_HOTSPOT", "THERMAL_VISUAL_HEAT_RISE", "THERMAL_VISUAL_WARM_BODY", "UNKNOWN" ] }, "ActivityEventData" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "boundingBoxes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClipBoundingBoxType" }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AddNewPassAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "absoluteIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "autoDailyInterval" : { "type" : "boolean", "nullable" : true }, "createWithExistingCredentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExistingGuestPassCredentialAssignment" }, "nullable" : true }, "createWithNewCredentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NewGuestPassCredentialSpec" }, "nullable" : true }, "dailyIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DailyMinuteIntervalType" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "action" : { "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" } }, "required" : [ "action" ] }, "AddOnLicenseEnum" : { "type" : "string", "enum" : [ "CLOUD_ARCHIVING", "PERCEPTION", "POSE", "BEHAVIOR", "VEHICLE", "PEOPLE", "PPE", "PEOPLE_ANALYTICS", "UNKNOWN" ] }, "AddOnLicenseInvoiceType" : { "type" : "object", "properties" : { "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "count" : { "type" : "integer", "format" : "int32", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "license" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "perceptionTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PerceptionTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "price" : { "type" : "number", "format" : "float", "nullable" : true } } }, "AddOnLicenseStats" : { "type" : "object", "properties" : { "addOnLicenseType" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "deviceLicenseFamilyStats" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" }, "nullable" : true }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "AddReusePassAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "absoluteIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "autoDailyInterval" : { "type" : "boolean", "nullable" : true }, "dailyIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DailyMinuteIntervalType" }, "nullable" : true }, "existingGuestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "action" : { "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" } }, "required" : [ "action" ] }, "AdvancedRMAType" : { "type" : "object", "properties" : { "falseReport" : { "type" : "boolean", "nullable" : true }, "invoiceNeeded" : { "type" : "boolean", "nullable" : true }, "knownIssue" : { "type" : "boolean", "nullable" : true }, "managerialApproved" : { "type" : "boolean", "nullable" : true }, "rctpPartnerRequested" : { "type" : "boolean", "nullable" : true }, "rctpPartnerUuid" : { "type" : "string", "nullable" : true }, "rectified" : { "type" : "boolean", "nullable" : true } } }, "AiProductEnum" : { "type" : "string", "description" : "AI product to update.", "enum" : [ "MIND", "CUSTOM_EVENTS" ] }, "AiProductModeEnum" : { "type" : "string", "description" : "Tier the org should run this product in.", "enum" : [ "FREE", "PREMIUM", "COMPED", "SELF", "DISABLED" ] }, "Aiconfig_AiProductConfigWSType" : { "type" : "object", "description" : "Per-org configuration of a single AI product. Never carries API keys.", "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp in milliseconds when this config was created", "nullable" : true }, "executionStrategy" : { "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" }, "mode" : { "$ref" : "#/components/schemas/AiProductModeEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "product" : { "$ref" : "#/components/schemas/AiProductEnum" }, "tokenValid" : { "type" : "boolean", "description" : "Indicator if the org-provided LLM API key is valid (MIND SELF tier only)", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp in milliseconds when this config was last updated", "nullable" : true } }, "required" : [ "mode", "orgUuid", "product" ] }, "Aiconfig_BaseAiProductConfigWSResponse" : { "type" : "object", "description" : "Response object carrying a single AI product config.", "properties" : { "config" : { "$ref" : "#/components/schemas/Aiconfig_AiProductConfigWSType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Aiconfig_GetAiProductConfigsWSRequest" : { "type" : "object", "description" : "Request object for retrieving the current org's AI product configs." }, "Aiconfig_GetAiProductConfigsWSResponse" : { "type" : "object", "description" : "Response object carrying the current org's AI product configs. Products without a config have never been provisioned and should be treated as DISABLED.", "properties" : { "configs" : { "type" : "array", "description" : "The org's AI product configurations, at most one per product.", "items" : { "$ref" : "#/components/schemas/Aiconfig_AiProductConfigWSType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Aiconfig_UpdateAiProductConfigWSRequest" : { "type" : "object", "description" : "Request object for updating the tier of one AI product for the current org.", "properties" : { "executionStrategy" : { "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" }, "mode" : { "$ref" : "#/components/schemas/AiProductModeEnum" }, "product" : { "$ref" : "#/components/schemas/AiProductEnum" } }, "required" : [ "mode", "product" ] }, "AirQualityIndexPollutantEnum" : { "type" : "string", "description" : "Primary pollutant affecting air quality index", "enum" : [ "OZONE", "PM2P5", "PM10P0", "CO", "NO2", "SO2", "UNKNOWN" ] }, "AlarmRule" : { "type" : "object", "description" : "The rules governing threat detection and subsequent actions.", "nullable" : true, "properties" : { "monitoredAccessControlledDevices" : { "type" : "array", "description" : "The UUIDs of access controlled devices (e.g. doors) monitored for the specified activities. If any\nmonitored device reports a matching activity, a threat case will be created.\n", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "monitoredDevices" : { "type" : "array", "description" : "The faceted UUIDs of devices monitored for the specified activities. If any monitored device reports\na matching activity, a threat case will be created.\n", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "siren" : { "$ref" : "#/components/schemas/AMSirenSettingsType" }, "threatQualifier" : { "$ref" : "#/components/schemas/ThreatQualifier" }, "triggers" : { "type" : "array", "description" : "The activity types that can trigger an alarm when reported by a monitored device.", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "tripwire" : { "$ref" : "#/components/schemas/TripwireSettings" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "threatQualifier", "triggers" ] }, "AlertActionRecordType" : { "type" : "object", "properties" : { "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/AlertActionStatusEnum" } } }, "AlertActionStatusEnum" : { "type" : "string", "enum" : [ "SUCCESS", "ERROR", "PAUSED", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] }, "AlertGroupingStrategyEnum" : { "type" : "string", "enum" : [ "ALARM_RULES", "POLICY", "CUSTOM_EVENTS", "DOORBELL", "MULTIPURPOSE_BUTTON" ] }, "AlertMonitoringCatalogItem" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "monthlyVerificationLimit" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "AlertMonitoringEventRecordType" : { "type" : "object", "properties" : { "alertMonitoringEventType" : { "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AlertMonitoringLicenseType" : { "type" : "object", "description" : "List of alert monitoring licenses available for the client organization", "properties" : { "allowedDeviceCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "monthlyFallbackVerificationLimit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "monthlyVerificationLimit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "monthsReset" : { "type" : "integer", "format" : "int32", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "percentUsage" : { "type" : "number", "format" : "double", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "remainingAlarms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "remainingFallbackVerifications" : { "type" : "integer", "format" : "int32", "nullable" : true }, "remainingVerifications" : { "type" : "integer", "format" : "int32", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningStage" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "AlertMonitoringPIN" : { "type" : "object", "description" : "Alert monitoring PIN to update.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in epoch ms when this PIN was created.", "nullable" : true, "readOnly" : true }, "description" : { "type" : "string", "description" : "PIN description.", "maxLength" : 255, "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when this PIN expires.", "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "Set of location uuids associated with this PIN.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "name" : { "type" : "string", "description" : "PIN name.", "maxLength" : 64, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rotatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in epoch ms when this PIN was last rotated.", "nullable" : true, "readOnly" : true }, "rotationPeriodDays" : { "type" : "integer", "format" : "int32", "description" : "Duration in days that determines when this PIN will be automatically rotated. If an expiration date is specified, that is when the first rotation will occur. Auto-rotation is disabled if this value is null.", "minimum" : 1, "nullable" : true }, "shared" : { "type" : "boolean", "description" : "Determines whether this PIN can be shared.", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when this PIN becomes active.", "nullable" : true }, "subLocationsHierarchyKeys" : { "type" : "array", "description" : "Set of sub-location keys associated with this PIN.", "items" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "nullable" : true, "uniqueItems" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in epoch ms when this PIN was last modified.", "nullable" : true, "readOnly" : true }, "userUuids" : { "type" : "array", "description" : "Set of user uuids associated with this PIN.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "description" : "PIN value.", "maxLength" : 16, "minLength" : 4, "nullable" : true } }, "required" : [ "value" ] }, "AlertMonitoringPinType" : { "type" : "object", "properties" : { "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "pin" : { "type" : "string", "nullable" : true } } }, "AlertMonitoringRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertMonitoringRulesEventType" : { "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" }, "locationUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "AlertMonitoringRulesEventTypeEnum" : { "type" : "string", "enum" : [ "ALARM_CREATED", "ALARM_CANCELED", "UNKNOWN" ] }, "AlertMonitoringSubmissionDelayIntervalType" : { "type" : "object", "properties" : { "escalationDelayMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfWeekStop" : { "type" : "integer", "format" : "int32", "nullable" : true }, "promptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" } } }, "AlertMonitoringThreatCaseType" : { "type" : "object", "description" : "List of threat cases matching the request criteria", "properties" : { "alertGroupingKeys" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "alertGroupingStrategy" : { "$ref" : "#/components/schemas/AlertGroupingStrategyEnum" }, "associatedDeviceUuids" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "noonlightAlarmId" : { "type" : "string", "nullable" : true }, "noonlightVerificationId" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertComponentCompositeUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "policyAlertDeviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "promptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "promptTitle" : { "type" : "string", "nullable" : true }, "sharedClipGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sirenSettings" : { "$ref" : "#/components/schemas/AMSirenSettingsType" }, "status" : { "$ref" : "#/components/schemas/ThreatCaseStatusEnum" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "submissionTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "submitDelayExpireTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "timelineEventList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "verificationHistory" : { "$ref" : "#/components/schemas/VerificationHistory" }, "verificationMode" : { "$ref" : "#/components/schemas/ThreatCaseVerificationModeEnum" } } }, "Alertmonitoring_AMDeviceHistogramItem" : { "type" : "object", "description" : "Histogram item representing alert monitoring data for a specific device.", "properties" : { "count" : { "type" : "integer", "format" : "int32", "description" : "The count of alerts for this device.", "nullable" : true }, "deviceName" : { "type" : "string", "description" : "The name of the device.", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceForLocationRequest" : { "type" : "object", "description" : "Request to accept the terms of service for alert monitoring at a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceRequest" : { "type" : "object", "description" : "Request to accept the terms of service for alert monitoring." }, "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceResponse" : { "type" : "object", "description" : "Response indicating the result of accepting alert monitoring terms of service.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_AddPromptThreatQualificationsWSRequest" : { "type" : "object", "description" : "Request to add a prompt threat qualification for an org.", "properties" : { "threatQualification" : { "$ref" : "#/components/schemas/NoonlightPromptSelection" } }, "required" : [ "threatQualification" ] }, "Alertmonitoring_AddPromptThreatQualificationsWSResponse" : { "type" : "object", "description" : "Response for adding a new prompt threat qualification.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_AmModifiedBy" : { "type" : "object", "description" : "Information about who modified an alert monitoring configuration and when.", "properties" : { "armed" : { "type" : "boolean", "description" : "Whether the alert monitoring is armed after the modification.", "nullable" : true }, "email" : { "type" : "string", "description" : "The email address of the user who made the modification.", "nullable" : true }, "event" : { "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy_AmModificationEvent" }, "timestamp" : { "type" : "integer", "format" : "int64", "description" : "The timestamp when the modification occurred in milliseconds since epoch.", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_AmModifiedBy_AmModificationEvent" : { "type" : "string", "description" : "Enumeration of possible modification events for alert monitoring.", "enum" : [ "UPDATED", "CREATED", "DELETED", "ARMED", "DISARMED", "NO_CHANGE" ] }, "Alertmonitoring_BulkDismissThreatCasesWSRequest" : { "type" : "object", "description" : "Request to dismiss multiple threat cases in alert monitoring.", "properties" : { "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against each threat case's zone and\nrecords a per-case error for those that fail authentication. Expected from clients that\ncannot identify their caller such as alarm pads.\n", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "threatCaseUuids" : { "type" : "array", "description" : "Unique identifiers of the threat cases to dismiss.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } }, "required" : [ "threatCaseUuids" ] }, "Alertmonitoring_BulkDismissThreatCasesWSResponse" : { "type" : "object", "description" : "Response listing the threat cases that could not be dismissed and the reason for each failure. Threat cases not present in the map were dismissed successfully.", "properties" : { "errors" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of failed threat case UUID to the error message describing why it could not be dismissed. Successfully dismissed threat cases are not included.", "nullable" : true }, "description" : "Map of failed threat case UUID to the error message describing why it could not be dismissed. Successfully dismissed threat cases are not included.", "nullable" : true } } }, "Alertmonitoring_CancelThreatCaseWSRequest" : { "type" : "object", "description" : "Request to cancel a threat case in alert monitoring.", "properties" : { "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Alertmonitoring_CancelThreatCaseWSResponse" : { "type" : "object", "description" : "Response indicating the result of canceling a threat case.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Indicates whether the threat case cancellation was successful", "example" : true, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_CountType" : { "type" : "object", "description" : "Represents count data for a specific day and month with activation/deactivation information.", "properties" : { "dayOfMonth" : { "type" : "integer", "format" : "int32", "description" : "The day of the month (1-31).", "nullable" : true }, "deactivated" : { "type" : "integer", "format" : "int32", "description" : "The number of deactivated items for this day and month.", "nullable" : true }, "month" : { "type" : "integer", "format" : "int32", "description" : "The month (1-12).", "nullable" : true }, "value" : { "type" : "integer", "format" : "int32", "description" : "The count value for this day and month.", "nullable" : true } } }, "Alertmonitoring_CreateCustomPinForNoonlightWSRequest" : { "type" : "object", "description" : "Request to create a custom PIN for alert monitoring at a specific location.", "properties" : { "description" : { "type" : "string", "description" : "Description of the PIN", "example" : "Custom PIN for main entrance access", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the PIN", "example" : "Custom Main Entrance PIN", "nullable" : true }, "pin" : { "type" : "string", "description" : "Custom PIN code to be created", "example" : "5678", "nullable" : true } } }, "Alertmonitoring_CreateCustomPinForNoonlightWSResponse" : { "type" : "object", "description" : "Response indicating the result of creating a custom PIN for alert monitoring.", "properties" : { "alreadyExists" : { "type" : "boolean", "description" : "Indicates whether the PIN already exists", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_CreateNoonlightSettingsForLocationRequest" : { "type" : "object", "description" : "Request to create alert monitoring settings for a location.", "properties" : { "noonlightSettings" : { "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" } } }, "Alertmonitoring_CreateNoonlightSettingsForLocationResponse" : { "type" : "object", "description" : "Response indicating the result of creating alert monitoring settings for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_CreatePinForNoonlightWSRequest" : { "type" : "object", "description" : "Request to create a PIN for alert monitoring at a specific location.", "properties" : { "description" : { "type" : "string", "description" : "Description of the PIN", "example" : "PIN for main entrance access", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the PIN", "example" : "Main Entrance PIN", "nullable" : true } } }, "Alertmonitoring_CreatePinForNoonlightWSResponse" : { "type" : "object", "description" : "Response containing the generated PIN for alert monitoring.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pin" : { "type" : "string", "description" : "The generated PIN code", "example" : "1234", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_CumulativeChartData" : { "type" : "object", "description" : "Chart data containing daily and cumulative monthly verification counts.", "properties" : { "cumulativeMonthlyVerifications" : { "type" : "array", "description" : "List of cumulative monthly verification counts.", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_CountType" }, "nullable" : true }, "dailyVerifications" : { "type" : "array", "description" : "List of daily verification counts.", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_CountType" }, "nullable" : true } } }, "Alertmonitoring_DeleteNoonlightSettingsForLocationRequest" : { "type" : "object", "description" : "Request to delete alert monitoring settings for a location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_DeleteNoonlightSettingsForLocationResponse" : { "type" : "object", "description" : "Response indicating the result of deleting alert monitoring settings for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_DeletePinForNoonlightWSRequest" : { "type" : "object", "description" : "Request to delete a PIN for alert monitoring at a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pin" : { "type" : "string", "description" : "PIN code to be deleted", "example" : "1234", "nullable" : true } } }, "Alertmonitoring_DeletePinForNoonlightWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting a PIN for alert monitoring.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_DeletePromptThreatQualificationByTitleWSRequest" : { "type" : "object", "description" : "Request to delete a prompt threat qualification for an org.", "properties" : { "title" : { "type" : "string", "description" : "The title of the prompt threat qualification to delete.", "nullable" : true } }, "required" : [ "title" ] }, "Alertmonitoring_DeletePromptThreatQualificationByTitleWSResponse" : { "type" : "object", "description" : "Response for deleting a prompt threat qualification.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_DisableLocationRequest" : { "type" : "object", "description" : "Request to disable alert monitoring for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pin" : { "type" : "string", "description" : "PIN code required to disable alert monitoring", "example" : "1234", "nullable" : true } } }, "Alertmonitoring_DisableLocationResponse" : { "type" : "object", "description" : "Response indicating the result of disabling alert monitoring for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_DismissThreatCaseWSRequest" : { "type" : "object", "description" : "Request to dismiss a threat case in alert monitoring.", "properties" : { "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Alertmonitoring_DismissThreatCaseWSResponse" : { "type" : "object", "description" : "Response indicating the result of dismissing a threat case.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Indicates whether the threat case dismissal was successful", "example" : true, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_EnableLocationRequest" : { "type" : "object", "description" : "Request to enable alert monitoring for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pin" : { "type" : "string", "description" : "The PIN code required to enable alert monitoring.", "nullable" : true } } }, "Alertmonitoring_EnableLocationResponse" : { "type" : "object", "description" : "Response indicating successful enabling of alert monitoring for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_EscalateThreatCaseToAlarmWSRequest" : { "type" : "object", "description" : "Request to escalate a threat case to an alarm for alert monitoring.", "properties" : { "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Alertmonitoring_EscalateThreatCaseToAlarmWSResponse" : { "type" : "object", "description" : "Response indicating the result of escalating a threat case to an alarm.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSRequest" : { "type" : "object", "description" : "Request to generate monthly verifications for year report for alert monitoring at specific locations.", "properties" : { "locationUuids" : { "type" : "array", "description" : "List of location UUIDs to generate monthly verifications for.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } }, "required" : [ "locationUuids" ] }, "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSResponse" : { "type" : "object", "description" : "Response containing monthly verifications for year report for alert monitoring at specific locations.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "verificationsPerMonthPerLocation" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "description" : "Map of location UUIDs to their monthly verification counts", "nullable" : true }, "description" : "Map of location UUIDs to their monthly verification counts", "nullable" : true }, "description" : "Map of location UUIDs to their monthly verification counts", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GenerateReportDataForLocationWSRequest" : { "type" : "object", "description" : "Request to generate report data for alert monitoring at a specific location.", "properties" : { "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time for the report period in milliseconds since epoch.", "example" : 1643673600000, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time for the report period in milliseconds since epoch.", "example" : 1640995200000, "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_GenerateReportDataForLocationWSResponse" : { "type" : "object", "description" : "Response containing generated report data for alert monitoring at a specific location.", "properties" : { "cumulativeChartData" : { "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "modifiedBy" : { "type" : "array", "description" : "List of modification records showing who made changes", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy" }, "nullable" : true }, "threatCaseReportItems" : { "type" : "array", "description" : "List of threat case report items for the report period", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" }, "nullable" : true }, "threatCases" : { "type" : "array", "description" : "Set of uuids corresponding to the threatcases that produced verifications in the report period", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "verificationsByDevice" : { "type" : "array", "description" : "List of device histogram items showing verifications by device", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GenerateReportDataForLocationWSResponseV2" : { "type" : "object", "description" : "Response containing generated report data for alert monitoring at a specific location.", "properties" : { "cumulativeChartData" : { "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "events" : { "type" : "array", "description" : "List of modification events showing who made changes", "items" : { "$ref" : "#/components/schemas/ALMEvent" }, "nullable" : true }, "threatCaseReportItems" : { "type" : "array", "description" : "List of threat case report items for the report period", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" }, "nullable" : true }, "threatCases" : { "type" : "array", "description" : "Set of uuids corresponding to the threat cases that produced verifications in the report period", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "verificationsByDevice" : { "type" : "array", "description" : "List of device histogram items showing verifications by device", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GetActiveThreatCaseReviewersWSRequest" : { "type" : "object", "description" : "Request to retrieve active reviewers for one or more threat cases.", "properties" : { "threatCaseUuids" : { "type" : "array", "description" : "Unique identifiers of the threat cases for which to retrieve active reviewers.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } }, "required" : [ "threatCaseUuids" ] }, "Alertmonitoring_GetActiveThreatCaseReviewersWSResponse" : { "type" : "object", "description" : "Response containing list of active threat case reviewers.", "properties" : { "reviewers" : { "type" : "array", "description" : "List of active threat case reviewers.", "items" : { "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReviewer" }, "nullable" : true } } }, "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSRequest" : { "type" : "object", "description" : "Request to get the count of tripwire groups for alert monitoring.", "properties" : { "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSResponse" : { "type" : "object", "description" : "Response containing the count of tripwire groups for alert monitoring.", "properties" : { "count" : { "type" : "integer", "format" : "int32", "description" : "Number of tripwire groups", "example" : 5, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve all monitored door sensors for a location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSResponse" : { "type" : "object", "description" : "Response containing all monitored door sensors for a location.", "properties" : { "doorStates" : { "type" : "array", "description" : "List of minimal door state information for all monitored door sensors in a location", "items" : { "$ref" : "#/components/schemas/Door_MinimalDoorStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GetNoonlightSettingsForLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve alert monitoring settings for a specific location.", "properties" : { "includePreviousVersions" : { "type" : "boolean", "description" : "If provided and true, response will contain a list of previous versions of the settings. For debugging purposes.", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_GetNoonlightSettingsForLocationWSResponse" : { "type" : "object", "description" : "Response containing alert monitoring settings for a specific location.", "properties" : { "alertMonitoringSettings" : { "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "previousVersions" : { "type" : "array", "description" : "List of previous versions of the alert monitoring settings", "items" : { "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GetNoonlightSettingsWSRequest" : { "type" : "object", "description" : "Request to retrieve alert monitoring settings." }, "Alertmonitoring_GetNoonlightSettingsWSResponse" : { "type" : "object", "description" : "Response containing alert monitoring settings for multiple locations.", "properties" : { "alertMonitoringSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" }, "description" : "Map of location UUIDs to their alert monitoring settings", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_GetPromptThreatQualificationsWSRequest" : { "type" : "object", "description" : "Request to retrieve prompt threat qualifications for an org." }, "Alertmonitoring_GetPromptThreatQualificationsWSResponse" : { "type" : "object", "description" : "Response containing prompt threat qualifications for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "threatQualifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightPromptSelection" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_LocationStatusWSRequest" : { "type" : "object", "description" : "Request to retrieve alarm monitoring status for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_LocationStatusWSResponse" : { "type" : "object", "description" : "Response containing alarm monitoring status for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/MonitoringEnableStatus" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_NoonlightWSSettings" : { "type" : "object", "description" : "Web service settings for Noonlight integration with alert monitoring.", "properties" : { "acceptedTermsOfService" : { "type" : "boolean", "nullable" : true }, "badgeAuthDisablesMonitoring" : { "type" : "boolean", "nullable" : true }, "defaultDelay" : { "type" : "integer", "format" : "int32", "nullable" : true }, "defaultEmergencyContact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "defaultPromptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "disabledOnMs" : { "type" : "integer", "format" : "int64", "description" : "The timestamp when Noonlight integration was disabled in milliseconds since epoch.", "nullable" : true }, "emergencyContacts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledOnMs" : { "type" : "integer", "format" : "int64", "description" : "The timestamp when Noonlight integration was enabled in milliseconds since epoch.", "nullable" : true }, "entryInstructions" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "manualEscalationSettings" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "modifiedByEmail" : { "type" : "string", "nullable" : true }, "modifiedByIntegration" : { "type" : "boolean", "nullable" : true }, "modifiedByMetadata" : { "type" : "string", "nullable" : true }, "modifiedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "modifiedTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "monitoringMode" : { "$ref" : "#/components/schemas/MonitoringModeEnum" }, "oneTimePauses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "oneTimeSchedules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pins" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertMonitoringPinType" }, "nullable" : true, "uniqueItems" : true }, "rules" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "schedules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "status" : { "$ref" : "#/components/schemas/MonitoringEnableStatus" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "talkdownEnabled" : { "type" : "boolean", "nullable" : true } } }, "Alertmonitoring_OrgStatusWSRequest" : { "type" : "object", "description" : "Request to retrieve alarm monitoring status for all locations in an organization.", "properties" : { "includeDeleted" : { "type" : "boolean", "description" : "If true, includes alert monitoring settings that were soft deleted in the response.", "example" : false, "nullable" : true } } }, "Alertmonitoring_OrgStatusWSResponse" : { "type" : "object", "description" : "Response containing alarm monitoring status for all locations in an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationStatuses" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MonitoringEnableStatus" }, "description" : "Map of location UUIDs to their monitoring enable status", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_RecordThreatCaseReviewerLeaveWSRequest" : { "type" : "object", "description" : "Request to record that a reviewer is no longer reviewing the specified threat case.", "properties" : { "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "threatCaseUuid" ] }, "Alertmonitoring_RecordThreatCaseReviewerLeaveWSResponse" : { "type" : "object", "description" : "Response indicating that a reviewer is no longer reviewing the specified threat case." }, "Alertmonitoring_RecordThreatCaseReviewerPresenceWSRequest" : { "type" : "object", "description" : "Request to record that a reviewer is actively viewing or reviewing the specified threat case.", "properties" : { "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "threatCaseUuid" ] }, "Alertmonitoring_RecordThreatCaseReviewerPresenceWSResponse" : { "type" : "object", "description" : "Response indicating that a reviewer is actively viewing or reviewing the specified threat case." }, "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSRequest" : { "type" : "object", "description" : "Request to reset the count of tripwire groups for alert monitoring.", "properties" : { "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds since epoch when the reset should occur", "example" : 1640995200000, "nullable" : true } } }, "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSResponse" : { "type" : "object", "description" : "Response indicating the result of resetting the tripwire group count for alert monitoring.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_ThreatCaseReportItem" : { "type" : "object", "description" : "Report item containing threat case information with device and alert details.", "properties" : { "alertGroupingKeys" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "alertGroupingStrategy" : { "$ref" : "#/components/schemas/AlertGroupingStrategyEnum" }, "alertNotFound" : { "type" : "boolean", "description" : "Whether the alert was not found for this threat case.", "nullable" : true }, "alertTypes" : { "type" : "array", "description" : "List of alert types associated with this threat case.", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "associatedDeviceUuids" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "deviceName" : { "type" : "string", "description" : "The name of the device involved in this threat case.", "nullable" : true }, "deviceNotFound" : { "type" : "boolean", "description" : "Whether the device was not found for this threat case.", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "noonlightAlarmId" : { "type" : "string", "nullable" : true }, "noonlightVerificationId" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertComponentCompositeUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "policyAlertDeviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "promptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "promptTitle" : { "type" : "string", "nullable" : true }, "reason" : { "type" : "string", "description" : "The reason for the threat case result.", "nullable" : true }, "result" : { "type" : "string", "description" : "The result of the threat case investigation.", "nullable" : true }, "sharedClipGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sirenSettings" : { "$ref" : "#/components/schemas/AMSirenSettingsType" }, "status" : { "$ref" : "#/components/schemas/ThreatCaseStatusEnum" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "submissionTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "submitDelayExpireTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "timelineEventList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "verificationHistory" : { "$ref" : "#/components/schemas/VerificationHistory" }, "verificationMode" : { "$ref" : "#/components/schemas/ThreatCaseVerificationModeEnum" } } }, "Alertmonitoring_ThreatCaseReviewer" : { "type" : "object", "description" : "Information about the user reviewing the threat case.", "properties" : { "name" : { "type" : "string", "description" : "Display name of the reviewer.", "nullable" : true }, "reviewerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_UpdateNoonlightSettingsForLocationRequest" : { "type" : "object", "description" : "Request to update alert monitoring settings for a location.", "properties" : { "noonlightSettings" : { "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" } } }, "Alertmonitoring_UpdateNoonlightSettingsForLocationResponse" : { "type" : "object", "description" : "Response indicating the result of updating alert monitoring settings for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_UpdatePromptThreatQualificationWSRequest" : { "type" : "object", "description" : "Request to update a prompt threat qualification for an org.", "properties" : { "promptSelection" : { "$ref" : "#/components/schemas/NoonlightPromptSelection" } }, "required" : [ "promptSelection" ] }, "Alertmonitoring_UpdatePromptThreatQualificationWSResponse" : { "type" : "object", "description" : "Response for updating a prompt threat qualification.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_AcceptALMLocationTermsOfServiceWSRequest" : { "type" : "object", "description" : "Request to accept terms of service for ALM location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_ArmMonitoringWSRequest" : { "type" : "object", "description" : "Request to arm monitoring.", "properties" : { "armingRule" : { "$ref" : "#/components/schemas/ArmMonitoringRule" }, "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against the target zone and rejects the\nrequest if authentication fails. Expected from clients that cannot identify their caller such\nas alarm pads.\n", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_CancelManualArmWSRequest" : { "type" : "object", "description" : "Request to cancel manual arming.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_CancelManualDisarmWSRequest" : { "type" : "object", "description" : "Request to cancel manual disarming.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_CreateLocationALMConfigWSRequest" : { "type" : "object", "description" : "Request to create a location ALM config.", "properties" : { "locationConfig" : { "$ref" : "#/components/schemas/LocationALMConfig" } }, "required" : [ "locationConfig" ] }, "Alertmonitoring_config_CreateZoneALMConfigWSRequest" : { "type" : "object", "description" : "Request to create a zone ALM config.", "properties" : { "monitoringEnabled" : { "type" : "boolean", "description" : "Whether to have monitoring enabled in manual mode.", "nullable" : true }, "zoneConfig" : { "$ref" : "#/components/schemas/ZoneALMConfig" } }, "required" : [ "zoneConfig" ] }, "Alertmonitoring_config_CreateZoneALMConfigWSResponse" : { "type" : "object", "description" : "Response containing a zone ALM config and monitoring state.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "monitoringState" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneConfig" : { "$ref" : "#/components/schemas/ZoneALMConfig" } } }, "Alertmonitoring_config_DeleteLocationALMConfigWSRequest" : { "type" : "object", "description" : "Request to delete a location ALM config.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_DeleteZoneALMConfigWSRequest" : { "type" : "object", "description" : "Request to delete a zone ALM config.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_DisarmMonitoringWSRequest" : { "type" : "object", "description" : "Request to disarm monitoring.", "properties" : { "authenticatePin" : { "type" : "boolean", "description" : "When true, the server authenticates the provided PIN against the target zone and rejects the\nrequest if authentication fails. Expected from clients that cannot identify their caller such\nas alarm pads.\n", "nullable" : true }, "disarmingRule" : { "$ref" : "#/components/schemas/DisarmMonitoringRule" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pin" : { "type" : "string", "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetALMZoneContextWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM zone context.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetALMZoneContextWSResponse" : { "type" : "object", "description" : "Response containing an ALM zone's context.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneContext" : { "$ref" : "#/components/schemas/ALMZoneContext" } } }, "Alertmonitoring_config_GetALMZoneContextsByLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM zone contexts by location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetALMZoneContextsByLocationWSResponse" : { "type" : "object", "description" : "Response containing ALM zone contexts for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneContexts" : { "type" : "array", "description" : "List of the latest ALM zone contexts in the location.", "items" : { "$ref" : "#/components/schemas/ALMZoneContext" }, "nullable" : true } } }, "Alertmonitoring_config_GetALMZoneContextsByOrgWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM zone contexts by org." }, "Alertmonitoring_config_GetALMZoneContextsByOrgWSResponse" : { "type" : "object", "description" : "Response containing ALM zone contexts for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneContexts" : { "type" : "array", "description" : "List of the latest ALM zone contexts in the org.", "items" : { "$ref" : "#/components/schemas/ALMZoneContext" }, "nullable" : true } } }, "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSRequest" : { "type" : "object", "description" : "Request to retrieve monitored devices in an ALM zone.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "modeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoringModeEnum" }, "nullable" : true, "uniqueItems" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSResponse" : { "type" : "object", "description" : "Response containing an ALM zone's monitored devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "monitoredAccessControlledDoors" : { "type" : "array", "description" : "List of monitored access controlled doors.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "monitoredDevices" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Lists of monitored devices by type.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "description" : "Lists of monitored devices by type.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_GetLocationALMConfigWSRequest" : { "type" : "object", "description" : "Request to retrieve a location ALM config.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetLocationALMConfigsByOrgWSRequest" : { "type" : "object", "description" : "Request to retrieve location ALM configs by org." }, "Alertmonitoring_config_GetLocationALMConfigsByOrgWSResponse" : { "type" : "object", "description" : "Response containing location ALM configs for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationConfigs" : { "type" : "array", "description" : "List of the latest location ALM configs in the org.", "items" : { "$ref" : "#/components/schemas/LocationALMConfig" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_GetMonitoringStateWSRequest" : { "type" : "object", "description" : "Request to retrieve a monitoring state.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetMonitoringStatesByLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve monitoring states by location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetMonitoringStatesByLocationWSResponse" : { "type" : "object", "description" : "Response containing monitoring states for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "monitoringStates" : { "type" : "array", "description" : "List of the latest monitoring states in the location.", "items" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_GetMonitoringStatesByOrgWSRequest" : { "type" : "object", "description" : "Request to retrieve monitoring states by org." }, "Alertmonitoring_config_GetMonitoringStatesByOrgWSResponse" : { "type" : "object", "description" : "Response containing monitoring states for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "monitoringStates" : { "type" : "array", "description" : "List of the latest monitoring states in the org.", "items" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_GetZoneALMConfigWSRequest" : { "type" : "object", "description" : "Request to retrieve a zone ALM config.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetZoneALMConfigsByLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve zone ALM configs by location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_GetZoneALMConfigsByLocationWSResponse" : { "type" : "object", "description" : "Response containing zone ALM configs for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneConfigs" : { "type" : "array", "description" : "List of the latest zone ALM configs in the location.", "items" : { "$ref" : "#/components/schemas/ZoneALMConfig" }, "nullable" : true } } }, "Alertmonitoring_config_GetZoneALMConfigsByOrgWSRequest" : { "type" : "object", "description" : "Request to retrieve zone ALM configs by org." }, "Alertmonitoring_config_GetZoneALMConfigsByOrgWSResponse" : { "type" : "object", "description" : "Response containing zone ALM configs for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneConfigs" : { "type" : "array", "description" : "List of the latest zone ALM configs in the org.", "items" : { "$ref" : "#/components/schemas/ZoneALMConfig" }, "nullable" : true } } }, "Alertmonitoring_config_ManageLocationALMConfigWSResponse" : { "type" : "object", "description" : "Response containing a location ALM config.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationConfig" : { "$ref" : "#/components/schemas/LocationALMConfig" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_ManageMonitoringStateWSResponse" : { "type" : "object", "description" : "Response containing a monitoring state.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "monitoringState" : { "$ref" : "#/components/schemas/ALMMonitoringState" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_config_ManageZoneALMConfigWSResponse" : { "type" : "object", "description" : "Response containing a zone ALM config.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneConfig" : { "$ref" : "#/components/schemas/ZoneALMConfig" } } }, "Alertmonitoring_config_SummarizeALMZoneStatusWSRequest" : { "type" : "object", "description" : "Request to summarize an ALM zone's status.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_SummarizeALMZoneStatusWSResponse" : { "type" : "object", "description" : "Response containing a summary of an ALM zone's status.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneSummary" : { "$ref" : "#/components/schemas/ALMZoneSummary" } } }, "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSRequest" : { "type" : "object", "description" : "Request to summarize a location's ALM zone statuses.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSResponse" : { "type" : "object", "description" : "Response containing summaries of ALM zone statuses for a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneSummaries" : { "type" : "array", "description" : "List of summaries of the ALM zone statuses in the location.", "items" : { "$ref" : "#/components/schemas/ALMZoneSummary" }, "nullable" : true } } }, "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSRequest" : { "type" : "object", "description" : "Request to summarize an org's ALM zone statuses." }, "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSResponse" : { "type" : "object", "description" : "Response containing summaries of ALM zone statuses for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zoneSummaries" : { "type" : "array", "description" : "List of summaries of the ALM zone statuses in the org.", "items" : { "$ref" : "#/components/schemas/ALMZoneSummary" }, "nullable" : true } } }, "Alertmonitoring_config_UpdateLocationALMConfigWSRequest" : { "type" : "object", "description" : "Request to update a location ALM config.", "properties" : { "update" : { "$ref" : "#/components/schemas/LocationALMConfig" } }, "required" : [ "update" ] }, "Alertmonitoring_config_UpdateZoneALMConfigWSRequest" : { "type" : "object", "description" : "Request to update a zone ALM config.", "properties" : { "update" : { "$ref" : "#/components/schemas/ZoneALMConfig" } }, "required" : [ "update" ] }, "Alertmonitoring_event_GetALMEventsByLocationWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM events for a specific location.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "minimal" : { "type" : "boolean", "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "sortAscending" : { "type" : "boolean", "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_event_GetALMEventsByOrgWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM events for the caller's org.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "minimal" : { "type" : "boolean", "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "sortAscending" : { "type" : "boolean", "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true } } }, "Alertmonitoring_event_GetALMEventsByPrincipalNameWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM events initiated by principals matching a name.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "minimal" : { "type" : "boolean", "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "principalName" : { "type" : "string", "description" : "Case-insensitive name of the principal to retrieve ALM events for.", "nullable" : true }, "sortAscending" : { "type" : "boolean", "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true } }, "required" : [ "principalName" ] }, "Alertmonitoring_event_GetALMEventsByPrincipalUuidWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM events initiated by a specific principal.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "minimal" : { "type" : "boolean", "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sortAscending" : { "type" : "boolean", "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true } }, "required" : [ "principalUuid" ] }, "Alertmonitoring_event_GetALMEventsByZoneWSRequest" : { "type" : "object", "description" : "Request to retrieve ALM events for a specific zone.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "minimal" : { "type" : "boolean", "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "sortAscending" : { "type" : "boolean", "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "locationUuid" ] }, "Alertmonitoring_event_GetALMEventsWSResponse" : { "type" : "object", "description" : "Response containing a page of ALM events.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "result" : { "$ref" : "#/components/schemas/DynamoPageResultALMEvent" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_pin_BasePinWSResponse" : { "type" : "object", "description" : "Base response containing alert monitoring PIN information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pin" : { "$ref" : "#/components/schemas/AlertMonitoringPIN" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_pin_BulkPinsWSResponse" : { "type" : "object", "description" : "Response containing multiple alert monitoring PINs for bulk operations.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedUsers" : { "type" : "array", "description" : "List of user UUIDs that failed during bulk operations.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "pins" : { "type" : "array", "description" : "List of alert monitoring PINs created or updated.", "items" : { "$ref" : "#/components/schemas/AlertMonitoringPIN" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_pin_BulkProvisionPinsWSRequest" : { "type" : "object", "description" : "Request to bulk provision alert monitoring PINs for multiple users.", "properties" : { "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "description" : "End date in epoch seconds when these PINs expire. PINs never expire if this value is left null.", "minimum" : 0, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "Set of location uuids these PINs are assigned to.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "notifyUsers" : { "type" : "boolean", "default" : false, "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", "maximum" : 16, "minimum" : 4, "nullable" : true }, "rotationPeriodDays" : { "type" : "integer", "format" : "int32", "description" : "Period in days when PINs should be automatically rotated. If left null, PINs will not be auto-rotated.", "minimum" : 1, "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "description" : "Start date in epoch seconds when these PINs become active. PINs activate immediately if this value is left null.", "minimum" : 0, "nullable" : true }, "subLocationsHierarchyKeys" : { "type" : "array", "description" : "Set of sub-location keys these PINs are assigned to.", "items" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "nullable" : true, "uniqueItems" : true }, "userUuids" : { "type" : "array", "description" : "Set of user uuids to provision PINs for.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } }, "required" : [ "pinLength", "userUuids" ] }, "Alertmonitoring_pin_BulkRotatePinsWSRequest" : { "type" : "object", "description" : "Request to bulk rotate multiple alert monitoring PINs.", "properties" : { "notifyUsers" : { "type" : "boolean", "default" : false, "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", "nullable" : true }, "pinLength" : { "type" : "integer", "format" : "int32", "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", "maximum" : 16, "minimum" : 4, "nullable" : true }, "pinUuids" : { "type" : "array", "description" : "Uuids of PINs to rotate in bulk.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } }, "required" : [ "pinLength", "pinUuids" ] }, "Alertmonitoring_pin_CreatePinWSRequest" : { "type" : "object", "description" : "Request to create a new alert monitoring PIN.", "properties" : { "notifyUser" : { "type" : "boolean", "default" : false, "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", "nullable" : true }, "pin" : { "$ref" : "#/components/schemas/AlertMonitoringPIN" } }, "required" : [ "pin" ] }, "Alertmonitoring_pin_DeletePinWSRequest" : { "type" : "object", "description" : "Request to delete an alert monitoring PIN by UUID.", "properties" : { "pinUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "pinUuid" ] }, "Alertmonitoring_pin_FindPinsByLocationAndUserWSRequest" : { "type" : "object", "description" : "Request to find alert monitoring PINs filtered by location and/or user.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_pin_FindPinsByOrgWSRequest" : { "type" : "object", "description" : "Request to find alert monitoring PINs in the organization with optional filtering and pagination.", "properties" : { "filter" : { "$ref" : "#/components/schemas/PinQueryFilter" }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Alertmonitoring_pin_FindPinsBySubLocationAndUserWSRequest" : { "type" : "object", "description" : "Request to find alert monitoring PINs filtered by sub-location and/or user.", "properties" : { "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Alertmonitoring_pin_FindPinsWSResponse" : { "type" : "object", "description" : "Response containing a list of alert monitoring PINs with optional pagination information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Last evaluated key for pagination in subsequent requests.", "nullable" : true }, "pins" : { "type" : "array", "description" : "List of alert monitoring PINs found.", "items" : { "$ref" : "#/components/schemas/AlertMonitoringPIN" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_pin_GetAvailableALMPinCodeWSRequest" : { "type" : "object", "description" : "Request to get an available PIN code for alert monitoring.", "properties" : { "pinLength" : { "type" : "integer", "format" : "int32", "description" : "Length of PIN to be generated.", "nullable" : true } }, "required" : [ "pinLength" ] }, "Alertmonitoring_pin_GetAvailableALMPinCodeWSResponse" : { "type" : "object", "description" : "Response containing an available PIN code for alert monitoring.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pinCode" : { "type" : "string", "description" : "The generated PIN code for alert monitoring.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Alertmonitoring_pin_GetPinWSRequest" : { "type" : "object", "description" : "Request to retrieve an alert monitoring PIN by UUID.", "properties" : { "pinUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "pinUuid" ] }, "Alertmonitoring_pin_RotatePinWSRequest" : { "type" : "object", "description" : "Request to rotate an alert monitoring PIN.", "properties" : { "notifyUser" : { "type" : "boolean", "default" : false, "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", "nullable" : true }, "pinUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "pinUuid" ] }, "Alertmonitoring_pin_UpdatePinWSRequest" : { "type" : "object", "description" : "Request to update an existing alert monitoring PIN.", "properties" : { "notifyUser" : { "type" : "boolean", "default" : false, "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their current PIN code. If no user is assigned, notifications will not be sent.", "nullable" : true }, "pin" : { "$ref" : "#/components/schemas/AlertMonitoringPIN" }, "selectiveUpdate" : { "type" : "boolean", "default" : false, "description" : "If set to true, only the non-null fields will be considered for this update.", "nullable" : true } }, "required" : [ "pin" ] }, "AlteredView" : { "type" : "object", "description" : "Map of device facet UUIDs to altered view configurations", "properties" : { "crop" : { "$ref" : "#/components/schemas/CroppedPermyriadRect" }, "dewarp" : { "$ref" : "#/components/schemas/DewarpedView" } } }, "AmtSettings" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true } } }, "AnnotationPosition" : { "type" : "object", "description" : "Normalized position of an annotation on a timeline entry's image, relative to the top-left corner. The position is independent of the displayed image size.", "properties" : { "x" : { "type" : "number", "format" : "float", "description" : "Normalized horizontal position, where 0 is the left edge and 1 is the right edge.", "maximum" : 1, "minimum" : 0, "nullable" : true }, "y" : { "type" : "number", "format" : "float", "description" : "Normalized vertical position, where 0 is the top edge and 1 is the bottom edge.", "maximum" : 1, "minimum" : 0, "nullable" : true } } }, "AntiPassbackModeEnum" : { "type" : "string", "enum" : [ "HARD_STRICT", "HARD_PERMISSIVE", "SOFT", "NONE" ] }, "AntiPassbackModeEnum_Minimal" : { "type" : "string", "enum" : [ "HARD_STRICT", "HARD_PERMISSIVE", "SOFT", "NONE" ] }, "AperioActivatorButton" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatorFunction" : { "$ref" : "#/components/schemas/AperioActivatorFunctionEnum" }, "buttonType" : { "$ref" : "#/components/schemas/ButtonEnumType" }, "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "eacAddress" ] }, "AperioActivatorFunctionEnum" : { "type" : "string", "enum" : [ "NONE", "PRIVACY" ] }, "AperioActivatorStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioBatteryStateEnum" : { "type" : "string", "enum" : [ "UNKNOWN", "FLAT", "LOW", "OK" ] }, "AperioDoorExtension" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorDeviceId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioDoorDeviceId", "aperioDoorId", "aperioGatewayId" ] }, "AperioDoorExtensionShadow" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatorState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "activatorStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "aperioDoorDeviceId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "aperioId" : { "type" : "string", "nullable" : true }, "batteryState" : { "$ref" : "#/components/schemas/AperioBatteryStateEnum" }, "clockRetrievedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "connected" : { "type" : "boolean", "nullable" : true }, "connectionStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceClockSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceTimezone" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorMode" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorModeUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dtcs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DtcInfo" }, "nullable" : true }, "dtcsUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "gatewayComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "handleState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "handleStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "keyCylinderState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "keyCylinderStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "removed" : { "type" : "boolean", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "tamperState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tamperStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AperioDoorExtensionStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatorState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "activatorStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "aperioId" : { "type" : "string", "nullable" : true }, "clockRetrievedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "connected" : { "type" : "boolean", "nullable" : true }, "connectionStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceClockSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceTimezone" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorMode" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorModeUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dtcs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DtcInfo" }, "nullable" : true }, "handleState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "handleStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "keyCylinderState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "keyCylinderStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "removed" : { "type" : "boolean", "nullable" : true }, "tamperState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tamperStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorHandleStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorModeEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorPositionIndicator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "dpiType" : { "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorReader" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "disableWaveToUnlock" : { "type" : "boolean", "nullable" : true }, "disposition" : { "$ref" : "#/components/schemas/ReaderDispositionEnum" }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "readerType" : { "$ref" : "#/components/schemas/DoorReaderEnumType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorRelay" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "deviceId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "relayType" : { "$ref" : "#/components/schemas/DoorRelayEnumType" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDoorRequestToExit" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorId" : { "type" : "string", "nullable" : true }, "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "intentOnly" : { "type" : "boolean", "nullable" : true }, "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "rexType" : { "$ref" : "#/components/schemas/RequestToExitEnumType" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioDtcEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDeviceId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dtcs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DtcInfo" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioGateway" : { "type" : "object", "properties" : { "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "hwVersion" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "oemCode" : { "type" : "string", "nullable" : true }, "oemGeneratedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioGatewayConnectionStateChangeEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "connected" : { "type" : "boolean", "nullable" : true }, "ipAddress" : { "type" : "string", "nullable" : true }, "stateChangedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioGatewayShadow" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "connected" : { "type" : "boolean", "nullable" : true }, "connectionStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceClockSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceTimezone" : { "type" : "integer", "format" : "int32", "nullable" : true }, "dtcs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DtcInfo" }, "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "hwVersion" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "ipAddress" : { "type" : "string", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "oemCode" : { "type" : "string", "nullable" : true }, "oemCodeFetchedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "protocolVersionMajor" : { "type" : "integer", "format" : "int32", "nullable" : true }, "protocolVersionMinor" : { "type" : "integer", "format" : "int32", "nullable" : true }, "protocolVersionPatch" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawTamperState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "AperioGatewayStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "connected" : { "type" : "boolean", "nullable" : true }, "connectionStateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceClockSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceTimezone" : { "type" : "integer", "format" : "int32", "nullable" : true }, "dtcs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DtcInfo" }, "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "hwVersion" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "ipAddress" : { "type" : "string", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "oemCode" : { "type" : "string", "nullable" : true }, "oemCodeFetchedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "protocolVersionMajor" : { "type" : "integer", "format" : "int32", "nullable" : true }, "protocolVersionMinor" : { "type" : "integer", "format" : "int32", "nullable" : true }, "protocolVersionPatch" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawTamperState" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioKeyCylinderStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioLockModelEnum" : { "type" : "string", "description" : "What kind of lock this is. Stated because the protocol does not report it: Device Info gives a product class, which says what a device does rather than which model it is. A model the controller cannot drive is refused - it has to be V3 hardware, which is the only generation that reports a door mode, and it has to lock something.", "enum" : [ "C100_V3", "E100_V3", "L100_V3", "H100_V3", "AU100_V3", "IN100_V3_MC", "G100_V3", "KL100_V3", "K100_V3_MC", "KS100_V3_MC", "ES100_V3_MC", "DL100_V3_MC", "DR100_V3_MC", "R100_V3_MC", "C100", "C100_V2SE", "E100", "E100_V2SE", "L100", "PROFILE_N2_MORTISE", "INCEPTA", "A100", "K100", "K100DI", "KS100", "M100", "R100" ], "example" : "IN100_V3_MC" }, "AperioRs485DoorExtension" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "model" : { "$ref" : "#/components/schemas/AperioLockModelEnum" }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioRs485DoorPositionIndicator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "dpiType" : { "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" }, "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioRs485DoorReader" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "disableWaveToUnlock" : { "type" : "boolean", "nullable" : true }, "disposition" : { "$ref" : "#/components/schemas/ReaderDispositionEnum" }, "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" }, "readerType" : { "$ref" : "#/components/schemas/DoorReaderEnumType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "eacAddress" ] }, "AperioRs485DoorRelay" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" }, "rateLimitingEnabled" : { "type" : "boolean", "nullable" : true }, "relayType" : { "$ref" : "#/components/schemas/DoorRelayEnumType" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioRs485DoorRequestToExit" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gatewayEacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "intentOnly" : { "type" : "boolean", "nullable" : true }, "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" }, "rexType" : { "$ref" : "#/components/schemas/RequestToExitEnumType" } } } ], "nullable" : true, "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioRs485Gateway" : { "type" : "object", "properties" : { "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "eacAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hwVersion" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/GenericRs485Port" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioTamperStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "aperioDoorId" : { "type" : "string", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "type" : "integer", "format" : "int32", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AperioType" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ApiClientTypeEnum" : { "type" : "string", "enum" : [ "PARTNER_DEVELOPER", "DEVELOPER", "DOOR_STATION", "INTERNAL_SALESFORCE", "TVOS", "WINDOWS", "LINUX", "KIOSK", "KEYPAD", "SQUARE", "KISI", "OPENPATH", "TOAST", "BOULEVARD", "BRIVO", "EXECUTABLE", "HALO", "SALTO", "BUTTERFLYMX", "GENEA", "PRODATAKEY", "ENVOY", "AMT", "PIMLOC", "PLACEOS", "OMNIALERT", "FLIC", "SHELLY_DEVICE_EVENT", "NINEONEONECELLULAR", "HONEYWELL_ELEMENTS", "HONEYWELL_ONGUARD", "HONEYWELL_NETBOX", "TRITON", "CHATBOT", "SIGNATURE_API", "INCOMING_WEBHOOK", "UNKNOWN" ] }, "ApiErrorResponse" : { "type" : "object", "description" : "Body of every error response. Branch on errorCode; show errorMsg. Fields are only ever added.", "properties" : { "code" : { "type" : "string", "description" : "Legacy alias of errorCode, present only for endpoint-specific codes." }, "detail" : { "type" : "string", "description" : "Legacy alias of errorMsg, present only for endpoint-specific codes." }, "error" : { "type" : "boolean", "description" : "Always true." }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code. New codes may be added; treat unknown codes as their HTTP status. Status 200 marks codes returned in a 200 body with error true. Catalog:\n- BAD_REQUEST (400): The request is invalid.\n- VALIDATION_FAILED (400): The request failed validation.\n- MISSING_REQUIRED_FIELD (400): The request is missing a required field.\n- INVALID_JSON (400): The request body is not valid JSON.\n- INVALID_REQUEST_BODY (400): The request body does not match the expected object structure.\n- METHOD_NOT_ALLOWED (405): This endpoint does not accept that HTTP method; the Allow header lists the ones it does.\n- UNSUPPORTED_MEDIA_TYPE (415): This endpoint does not accept that Content-Type. Send application/json.\n- FEATURE_NOT_ENABLED (400): This feature is not enabled for the organization.\n- UNAUTHENTICATED (401): Authentication is required. Supply valid credentials.\n- FORBIDDEN (403): You do not have permission to perform this action.\n- NOT_FOUND (404): The requested resource was not found.\n- CONFLICT (409): The request conflicts with the current state of the resource.\n- RATE_LIMITED (429): Too many requests; try again later.\n- INTERNAL_ERROR (500): An unexpected error occurred.\n- SERVICE_UNAVAILABLE (503): The service is temporarily unavailable; try again shortly.\n- REQUEST_FAILED (200): The request could not be completed.\n- INVALID_CREDENTIAL (401): The supplied credential is malformed or not recognized.\n- CREDENTIAL_EXPIRED (401): The supplied credential has expired.\n- CREDENTIAL_REVOKED (401): The supplied credential has been revoked.\n- CERTIFICATE_MISMATCH (401): The client certificate does not match the supplied credential.\n- INVALID_AUTH_ORG (400): The x-auth-org header is not a valid organization UUID.\n- DOMAIN_NOT_ALLOWED (403): Requests from this domain are not allowed for this credential.\n- DEVICE_SCOPE_MISMATCH (403): This token is scoped to a different device.\n- ROLE_NOT_PERMITTED (403): Your role does not permit access to this organization.\n- FUNCTIONALITY_REQUIRED (403): Your role is missing a functionality this action requires.\n- PARTNER_FUNCTIONALITY_REQUIRED (403): Your partner role is missing a functionality this action requires.\n- PERMISSION_REQUIRED (403): Your role does not have the required permission on the requested resource.\n- PARTNER_CLIENT_ACCESS_DENIED (403): Your partner organization does not have access to this client organization.\n- HARDWARE_NOT_AVAILABLE (403): No hardware with this serial number is available for your organization to register.\n- HARDWARE_ALREADY_REGISTERED (403): This hardware is already registered to an organization. Remove it from that organization before registering it again.\n- LOCATION_NOT_FOUND (400): The location was not found in the target organization.\n- PARTNER_PORTAL_NOT_ENABLED (403): The partner portal is not enabled for your partner organization. Contact Rhombus support.\n- MANAGED_BY_MSP (403): This organization is managed by a Managed Service Provider. Contact the provider or Rhombus support.\n- SUPER_ADMIN_RESTRICTED_BY_MSP (403): The Super Admin role in this organization is managed by a Managed Service Provider. Contact the provider or Rhombus support.\n- MSP_DESIGNATION_INVALID (403): This operation requires an active, signed Managed Service Provider designation.\n- NOT_MANAGED_CLIENT (403): This organization is not a managed client of your Managed Service Provider account.\n- DEVICES_STILL_REGISTERED (200): Devices are still registered in this client organization.\n- LICENSES_STILL_ASSIGNED (200): Licenses you own are still assigned to devices in this client organization.\n- DOOR_BOUND_HARDWARE (200): This device is bound to one or more access-controlled doors. Remove the bindings in the source organization before moving it.\n- CONFIRM_NAME_MISMATCH (409): The confirmation text does not match the client organization name.\n- DUPLICATE_CLIENT_NAME (409): You already manage a client organization with this name. Set allowDuplicateName to create it anyway.\n- LICENSE_V2_DISABLED (409): Pooled licenses cannot be assigned to this client organization because it is not on license entitlements. Contact Rhombus support.\n- INSUFFICIENT_POOL_LICENSES (409): Not enough unassigned licenses of this product in the pool.", "x-rhombus-error-codes" : [ { "code" : "BAD_REQUEST", "message" : "The request is invalid.", "status" : 400 }, { "code" : "VALIDATION_FAILED", "message" : "The request failed validation.", "status" : 400 }, { "code" : "MISSING_REQUIRED_FIELD", "message" : "The request is missing a required field.", "status" : 400 }, { "code" : "INVALID_JSON", "message" : "The request body is not valid JSON.", "status" : 400 }, { "code" : "INVALID_REQUEST_BODY", "message" : "The request body does not match the expected object structure.", "status" : 400 }, { "code" : "METHOD_NOT_ALLOWED", "message" : "This endpoint does not accept that HTTP method; the Allow header lists the ones it does.", "status" : 405 }, { "code" : "UNSUPPORTED_MEDIA_TYPE", "message" : "This endpoint does not accept that Content-Type. Send application/json.", "status" : 415 }, { "code" : "FEATURE_NOT_ENABLED", "message" : "This feature is not enabled for the organization.", "status" : 400 }, { "code" : "UNAUTHENTICATED", "message" : "Authentication is required. Supply valid credentials.", "status" : 401 }, { "code" : "FORBIDDEN", "message" : "You do not have permission to perform this action.", "status" : 403 }, { "code" : "NOT_FOUND", "message" : "The requested resource was not found.", "status" : 404 }, { "code" : "CONFLICT", "message" : "The request conflicts with the current state of the resource.", "status" : 409 }, { "code" : "RATE_LIMITED", "message" : "Too many requests; try again later.", "status" : 429 }, { "code" : "INTERNAL_ERROR", "message" : "An unexpected error occurred.", "status" : 500 }, { "code" : "SERVICE_UNAVAILABLE", "message" : "The service is temporarily unavailable; try again shortly.", "status" : 503 }, { "code" : "REQUEST_FAILED", "message" : "The request could not be completed.", "status" : 200 }, { "code" : "INVALID_CREDENTIAL", "message" : "The supplied credential is malformed or not recognized.", "status" : 401 }, { "code" : "CREDENTIAL_EXPIRED", "message" : "The supplied credential has expired.", "status" : 401 }, { "code" : "CREDENTIAL_REVOKED", "message" : "The supplied credential has been revoked.", "status" : 401 }, { "code" : "CERTIFICATE_MISMATCH", "message" : "The client certificate does not match the supplied credential.", "status" : 401 }, { "code" : "INVALID_AUTH_ORG", "message" : "The x-auth-org header is not a valid organization UUID.", "status" : 400 }, { "code" : "DOMAIN_NOT_ALLOWED", "message" : "Requests from this domain are not allowed for this credential.", "status" : 403 }, { "code" : "DEVICE_SCOPE_MISMATCH", "message" : "This token is scoped to a different device.", "status" : 403 }, { "code" : "ROLE_NOT_PERMITTED", "message" : "Your role does not permit access to this organization.", "status" : 403 }, { "code" : "FUNCTIONALITY_REQUIRED", "message" : "Your role is missing a functionality this action requires.", "status" : 403 }, { "code" : "PARTNER_FUNCTIONALITY_REQUIRED", "message" : "Your partner role is missing a functionality this action requires.", "status" : 403 }, { "code" : "PERMISSION_REQUIRED", "message" : "Your role does not have the required permission on the requested resource.", "status" : 403 }, { "code" : "PARTNER_CLIENT_ACCESS_DENIED", "message" : "Your partner organization does not have access to this client organization.", "status" : 403 }, { "code" : "HARDWARE_NOT_AVAILABLE", "message" : "No hardware with this serial number is available for your organization to register.", "status" : 403 }, { "code" : "HARDWARE_ALREADY_REGISTERED", "message" : "This hardware is already registered to an organization. Remove it from that organization before registering it again.", "status" : 403 }, { "code" : "LOCATION_NOT_FOUND", "message" : "The location was not found in the target organization.", "status" : 400 }, { "code" : "PARTNER_PORTAL_NOT_ENABLED", "message" : "The partner portal is not enabled for your partner organization. Contact Rhombus support.", "status" : 403 }, { "code" : "MANAGED_BY_MSP", "message" : "This organization is managed by a Managed Service Provider. Contact the provider or Rhombus support.", "status" : 403 }, { "code" : "SUPER_ADMIN_RESTRICTED_BY_MSP", "message" : "The Super Admin role in this organization is managed by a Managed Service Provider. Contact the provider or Rhombus support.", "status" : 403 }, { "code" : "MSP_DESIGNATION_INVALID", "message" : "This operation requires an active, signed Managed Service Provider designation.", "status" : 403 }, { "code" : "NOT_MANAGED_CLIENT", "message" : "This organization is not a managed client of your Managed Service Provider account.", "status" : 403 }, { "code" : "DEVICES_STILL_REGISTERED", "message" : "Devices are still registered in this client organization.", "status" : 200 }, { "code" : "LICENSES_STILL_ASSIGNED", "message" : "Licenses you own are still assigned to devices in this client organization.", "status" : 200 }, { "code" : "DOOR_BOUND_HARDWARE", "message" : "This device is bound to one or more access-controlled doors. Remove the bindings in the source organization before moving it.", "status" : 200 }, { "code" : "CONFIRM_NAME_MISMATCH", "message" : "The confirmation text does not match the client organization name.", "status" : 409 }, { "code" : "DUPLICATE_CLIENT_NAME", "message" : "You already manage a client organization with this name. Set allowDuplicateName to create it anyway.", "status" : 409 }, { "code" : "LICENSE_V2_DISABLED", "message" : "Pooled licenses cannot be assigned to this client organization because it is not on license entitlements. Contact Rhombus support.", "status" : 409 }, { "code" : "INSUFFICIENT_POOL_LICENSES", "message" : "Not enough unassigned licenses of this product in the pool.", "status" : 409 } ] }, "errorMsg" : { "type" : "string", "description" : "Client-facing message." }, "msg" : { "type" : "string", "description" : "Legacy: the HTTP reason phrase." }, "status" : { "type" : "integer", "format" : "int32", "description" : "The HTTP status code." }, "timestamp" : { "type" : "integer", "format" : "int64", "description" : "Epoch milliseconds." }, "txid" : { "type" : "string", "description" : "Transaction id, also in the x-rhombus-txid header. Quote it to support." } } }, "ApiTokenApplicationType" : { "type" : "object", "properties" : { "authType" : { "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" }, "authenticationTokenHash" : { "type" : "string", "nullable" : true }, "clientDetails" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/ApiClientTypeEnum" }, "csr" : { "type" : "string", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ApiTokenAuthTypeEnum" : { "type" : "string", "description" : "Authentication type for the API token", "enum" : [ "API_TOKEN", "CERT" ] }, "ApiTokenEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "tokenName" : { "type" : "string", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, "ApiTokenLockdownEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "tokenName" : { "type" : "string", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" } } }, "ApiTokenType" : { "type" : "object", "description" : "List of API tokens", "properties" : { "allowedRequetsPerSecond" : { "type" : "integer", "format" : "int32", "nullable" : true }, "authType" : { "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" }, "authenticationTokenHash" : { "type" : "string", "nullable" : true }, "cert" : { "type" : "string", "nullable" : true }, "certFingerprint" : { "type" : "string", "nullable" : true }, "clientDetails" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/ApiClientTypeEnum" }, "csr" : { "type" : "string", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "hashed" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "restrictToAllowedIps" : { "type" : "boolean", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AppleWalletDesfireCredential" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "adminKeyDiversificationData" : { "type" : "string", "nullable" : true }, "algorithm" : { "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" }, "appName" : { "type" : "string", "nullable" : true }, "appOS" : { "type" : "string", "nullable" : true }, "appStatusUpdatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "appVersion" : { "type" : "string", "nullable" : true }, "baseKeyIdentifier" : { "type" : "integer", "format" : "int32", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/MobileTokenOSEnum" }, "deviceModel" : { "type" : "string", "nullable" : true }, "installationId" : { "type" : "string", "nullable" : true }, "userAgent" : { "type" : "string", "nullable" : true }, "userAuthRequired" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "assigneeType" : { "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" }, "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedAccessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUsedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lowercaseHexValue" : { "type" : "string", "nullable" : true, "readOnly" : true }, "managedCredUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "nullable" : true }, "workflowStatus" : { "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, "Apple_wallet_AppleWalletDeviceRegistrationWSRequest" : { "type" : "object", "properties" : { "pushToken" : { "type" : "string", "nullable" : true } } }, "Apple_wallet_AppleWalletLogWSRequest" : { "type" : "object", "properties" : { "logs" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "ArmMonitoringRule" : { "type" : "object", "description" : "Rule used to manually arm scheduled alarm policies while the monitoring mode is set to scheduled.\n", "properties" : { "activeSinceMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX timestamp (in milliseconds) when this rule went into effect.", "nullable" : true }, "armAllUntilMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX timestamp (in milliseconds) to manually arm all alarm policies until.", "nullable" : true }, "armedAlarmPolicies" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will next resume (i.e., when the manual arm expires).\n", "nullable" : true }, "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will next resume (i.e., when the manual arm expires).\n", "nullable" : true } } }, "AspectRatio" : { "type" : "object", "properties" : { "height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "width" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "AudioExpressionDetectionConfig" : { "type" : "object", "properties" : { "category" : { "$ref" : "#/components/schemas/ActivityEnum" }, "confidence_min" : { "type" : "number", "format" : "float", "nullable" : true }, "expression" : { "type" : "string", "nullable" : true }, "loudness_min" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "AudioGatewayStatusEnum" : { "type" : "string", "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "INITIATED", "SUBMITTED", "UNKNOWN" ] }, "AudioLoudActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "audioLufsThreshold" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "AudioParamConfig" : { "type" : "object", "description" : "Audio analysis parameters", "properties" : { "expressions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AudioExpressionDetectionConfig" }, "nullable" : true }, "significant_loudness_min" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "AudioPlaybackActionRecordType" : { "type" : "object", "properties" : { "audioClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "audioGatewayStatuses" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AudioGatewayStatusEnum" }, "nullable" : true } } }, "AudioPlaybackActionType" : { "type" : "object", "properties" : { "audioClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "audioGateways" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "loopDurationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "playCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "source" : { "$ref" : "#/components/schemas/AudioPlaybackSourceEnum" } } }, "AudioPlaybackSourceEnum" : { "type" : "string", "enum" : [ "ON_DEVICE", "STREAM" ] }, "AudioPolicyType" : { "type" : "object", "description" : "List of audio policies using the schedule", "properties" : { "defaultTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AudioTriggerType" }, "nullable" : true, "uniqueItems" : true }, "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AudioScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AudioScheduledTriggerType" : { "type" : "object", "properties" : { "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AudioTriggerType" }, "nullable" : true, "uniqueItems" : true } } }, "AudioTriggerType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "threshold" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "AudioUploadMetadataType" : { "type" : "object", "description" : "List of audio upload metadata for the organization", "properties" : { "audioPlaintext" : { "type" : "string", "nullable" : true }, "audioSSML" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "durationMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "mutable" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "s3ObjectKey" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "voiceId" : { "type" : "string", "nullable" : true } } }, "Audiogateway_AudioGatewayOfflineLanStreamingInfo" : { "type" : "object", "description" : "Information for offline LAN streaming of audio gateway content.", "properties" : { "accessToken" : { "type" : "string", "description" : "Access token for offline LAN streaming", "example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "nullable" : true }, "lanAddresses" : { "type" : "array", "description" : "List of LAN addresses for offline streaming", "items" : { "type" : "string", "description" : "List of LAN addresses for offline streaming", "nullable" : true }, "nullable" : true } } }, "Audiogateway_DeleteAudioGatewayWSRequest" : { "type" : "object", "description" : "Request to remove an audio gateway from organization.", "properties" : { "gatewayUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Indicates whether to mummify the audio gateway", "example" : false, "nullable" : true } } }, "Audiogateway_DeleteAudioGatewayWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting an audio gateway.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetAudioGatewayConfigWSRequest" : { "type" : "object", "description" : "Request to get configuration for an audio gateway.", "properties" : { "audioGatewayUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Audiogateway_GetAudioGatewayConfigWSResponse" : { "type" : "object", "description" : "Response containing configuration for an audio gateway.", "properties" : { "config" : { "$ref" : "#/components/schemas/IAudioUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSRequest" : { "type" : "object", "description" : "Request to get offline LAN streaming information for all audio gateways." }, "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSResponse" : { "type" : "object", "description" : "Response containing offline LAN streaming information for all audio gateways.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "info" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Audiogateway_AudioGatewayOfflineLanStreamingInfo" }, "description" : "Map of audio gateway UUIDs to their offline LAN streaming information", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetAudioSeekpointsWSRequest" : { "type" : "object", "description" : "Request to get audio seek points for an audio gateway.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "duration" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds since epoch", "example" : 1640995200000, "nullable" : true } } }, "Audiogateway_GetAudioSeekpointsWSResponse" : { "type" : "object", "description" : "Response containing audio seek points for an audio gateway.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageSeekPoints" : { "type" : "array", "description" : "List of audio seek points for the specified time period", "items" : { "$ref" : "#/components/schemas/FootageSeekPointV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetFullAudioGatewayStateWSRequest" : { "type" : "object", "description" : "Request to get detailed information about the state of a specified audio gateway.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "force" : { "type" : "boolean", "description" : "Force refresh of the device state", "example" : false, "nullable" : true } } }, "Audiogateway_GetFullAudioGatewayStateWSResponse" : { "type" : "object", "description" : "Response containing detailed information about the state of a specified audio gateway.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "fullAudioGatewayState" : { "$ref" : "#/components/schemas/FullDeviceStateType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetMediaUrisWSRequest" : { "type" : "object", "description" : "Request to get media URIs for an audio gateway to retrieve footage.", "properties" : { "gatewayUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Audiogateway_GetMediaUrisWSResponse" : { "type" : "object", "description" : "Response containing media URIs for audio gateway footage retrieval.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lanCheckUrls" : { "type" : "array", "description" : "List of LAN check URLs to verify device availability on local network", "items" : { "type" : "string", "description" : "List of LAN check URLs to verify device availability on local network", "nullable" : true }, "nullable" : true }, "lanLiveMpdUris" : { "type" : "array", "description" : "List of LAN live MPD URIs for local network media streaming", "items" : { "type" : "string", "description" : "List of LAN live MPD URIs for local network media streaming", "nullable" : true }, "nullable" : true }, "lanLiveOpusUris" : { "type" : "array", "description" : "List of LAN live Opus URIs for local network audio streaming", "items" : { "type" : "string", "description" : "List of LAN live Opus URIs for local network audio streaming", "nullable" : true }, "nullable" : true }, "lanVodMpdUrisTemplates" : { "type" : "array", "description" : "List of LAN VOD MPD URI templates for local network video on demand", "items" : { "type" : "string", "description" : "List of LAN VOD MPD URI templates for local network video on demand", "nullable" : true }, "nullable" : true }, "wanLiveMpdUri" : { "type" : "string", "description" : "WAN live MPD URI for real-time media streaming", "nullable" : true }, "wanLiveOpusUri" : { "type" : "string", "description" : "WAN live Opus URI for real-time audio streaming", "nullable" : true }, "wanVodMpdUriTemplate" : { "type" : "string", "description" : "WAN VOD MPD URI template for video on demand content", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_GetMinimalAudioGatewayStatesWSRequest" : { "type" : "object", "description" : "Request to get basic state information for all audio gateways." }, "Audiogateway_GetMinimalAudioGatewayStatesWSResponse" : { "type" : "object", "description" : "Response containing basic state information for all audio gateways.", "properties" : { "audioGatewayStates" : { "type" : "array", "description" : "List of minimal audio gateway state information", "items" : { "$ref" : "#/components/schemas/MinimalAudioGatewayStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_RebootAudioGatewayWSRequest" : { "type" : "object", "description" : "Request to reboot the specified audio gateway.", "properties" : { "audioGatewayUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "audioGatewayUuid" ] }, "Audiogateway_UpdateAudioGatewayConfigWSRequest" : { "type" : "object", "description" : "Request to update configuration for an audio gateway.", "properties" : { "audioAnalysisParams" : { "$ref" : "#/components/schemas/AudioParamConfig" }, "audioExternalMicBoost" : { "type" : "integer", "format" : "int32", "description" : "Adjust boost for external mic. Integer between 0 and 3.", "example" : 1, "nullable" : true }, "audioExternalMicVolume" : { "type" : "integer", "format" : "int32", "description" : "Adjust volume for external mic. Integer between 0 and 63.", "example" : 32, "nullable" : true }, "audioExternalSpeakerVolume" : { "type" : "integer", "format" : "int32", "description" : "Adjust volume for external speaker. Integer between 0 and 127.", "example" : 64, "nullable" : true }, "audioInternalMicAecEnabled" : { "type" : "boolean", "description" : "Enable acoustic echo cancellation for internal microphone", "example" : true, "nullable" : true }, "audioInternalMicBoost" : { "type" : "integer", "format" : "int32", "description" : "Adjust boost for internal mic. Integer between 0 and 3.", "example" : 1, "nullable" : true }, "audioInternalMicVolume" : { "type" : "integer", "format" : "int32", "description" : "Adjust volume for internal mic. Integer between 0 and 63.", "example" : 32, "nullable" : true }, "audioInternalSpeakerVolume" : { "type" : "integer", "format" : "int32", "description" : "Adjust volume for internal speaker. Integer between 0 and 127.", "example" : 64, "nullable" : true }, "audioRecord" : { "type" : "boolean", "description" : "Enable/disable audio recording. Cannot set to true unless organization settings allow it", "example" : true, "nullable" : true }, "audioUseExternalMic" : { "type" : "boolean", "description" : "Use external microphone instead of internal", "example" : false, "nullable" : true }, "audioUseExternalSpeaker" : { "type" : "boolean", "description" : "Use external speaker instead of internal", "example" : false, "nullable" : true }, "deviceMicEnabled" : { "type" : "boolean", "description" : "Enable/disable device mic. Cannot set to true unless organization settings allow it", "example" : true, "nullable" : true }, "deviceSpeakerEnabled" : { "type" : "boolean", "description" : "Enable/disable device speaker", "example" : true, "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "description" : "Enable frontend noise suppression", "example" : true, "nullable" : true }, "uuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Audiogateway_UpdateAudioGatewayConfigWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating audio gateway configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audiogateway_UpdateAudioGatewayDetailsWSRequest" : { "type" : "object", "description" : "Request to update details for an audio gateway. Note: uuid is a required field.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "associatedCamerasUpdated" : { "type" : "boolean", "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Indicates whether the audio gateway is deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the audio gateway", "example" : "Audio gateway for main entrance monitoring", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the audio gateway is located", "example" : 1, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the audio gateway location", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the audio gateway location", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the audio gateway", "example" : "Main Entrance Audio Gateway", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Audiogateway_UpdateAudioGatewayDetailsWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating audio gateway details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_CancelLoopingAudioPlaybackWSRequest" : { "type" : "object", "description" : "Request to cancel looping audio playback on audio devices.", "properties" : { "audioDevices" : { "type" : "array", "description" : "List of audio device UUIDs to cancel looping playback on", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true } } }, "Audioplayback_CancelLoopingAudioPlaybackWSResponse" : { "type" : "object", "description" : "Response from canceling looping audio playback.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "successMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "description" : "Map of audio device UUIDs to success status for canceling playback", "nullable" : true }, "description" : "Map of audio device UUIDs to success status for canceling playback", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_DeleteAudioUploadMetadataWSRequest" : { "type" : "object", "description" : "Request to delete audio upload metadata.", "properties" : { "audioUploadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Audioplayback_DeleteAudioUploadMetadataWSResponse" : { "type" : "object", "description" : "Response from deleting audio upload metadata.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_GetAudioUploadMetadataForOrgWSRequest" : { "type" : "object", "description" : "Request to get audio upload metadata for organization." }, "Audioplayback_GetAudioUploadMetadataForOrgWSResponse" : { "type" : "object", "description" : "Response containing audio upload metadata for organization.", "properties" : { "audioUploadMetadata" : { "type" : "array", "description" : "List of audio upload metadata for the organization", "items" : { "$ref" : "#/components/schemas/AudioUploadMetadataType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_PlayAudioUploadWSRequest" : { "type" : "object", "description" : "Request to play an uploaded audio clip through audio devices.", "properties" : { "audioGatewayUuids" : { "type" : "array", "description" : "List of audio gateway device UUIDs to play audio through", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "audioUploadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "loopDurationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds to loop the audio playback", "example" : 30, "nullable" : true }, "playCount" : { "type" : "integer", "format" : "int32", "description" : "Number of times to play the audio clip", "example" : 1, "nullable" : true } } }, "Audioplayback_PlayAudioUploadWSResponse" : { "type" : "object", "description" : "Response from playing an uploaded audio clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Indicates if audio playback was successful", "example" : true, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_UpdateAudioUploadMetadataWSRequest" : { "type" : "object", "description" : "Request to update audio upload metadata.", "properties" : { "audioUploadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newDescription" : { "type" : "string", "description" : "New description for the audio clip", "example" : "Updated welcome message for visitors", "nullable" : true }, "newDisplayName" : { "type" : "string", "description" : "New display name for the audio clip", "example" : "Updated Welcome Message", "nullable" : true } } }, "Audioplayback_UpdateAudioUploadMetadataWSResponse" : { "type" : "object", "description" : "Response from updating audio upload metadata.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_UploadAudioPcmWSResponse" : { "type" : "object", "description" : "Response from uploading PCM audio clip.", "properties" : { "encodingFailure" : { "type" : "boolean", "description" : "Indicates if audio encoding failed", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Audioplayback_UploadAudioTextWSRequest" : { "type" : "object", "description" : "Request to upload text for audio synthesis.", "properties" : { "audioPlaintext" : { "type" : "string", "description" : "Plain text to synthesize into audio", "example" : "Welcome to our facility", "nullable" : true }, "audioSSML" : { "type" : "string", "description" : "SSML markup for audio synthesis", "example" : "Welcome to our facility", "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the audio clip", "example" : "A welcome message for visitors", "nullable" : true }, "displayName" : { "type" : "string", "description" : "Display name for the audio clip", "example" : "Welcome Message", "nullable" : true }, "voiceId" : { "type" : "string", "description" : "Voice ID for text-to-speech synthesis", "example" : "en-US-Neural2-F", "nullable" : true } } }, "Audioplayback_UploadAudioTextWSResponse" : { "type" : "object", "description" : "Response from uploading text for audio synthesis.", "properties" : { "encodingFailure" : { "type" : "boolean", "description" : "Indicates if audio encoding failed", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invalidSSML" : { "type" : "boolean", "description" : "Indicates if SSML markup is invalid", "example" : false, "nullable" : true }, "synthesisFailure" : { "type" : "boolean", "description" : "Indicates if text-to-speech synthesis failed", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "AuditActionEnum" : { "type" : "string", "enum" : [ "THREAT_CASE_ESCALATED", "THREAT_CASE_CANCELLED", "THREAT_CASE_DISMISSED", "THREAT_CASE_DELETED", "THREAT_CASE_DELETE_BY_STATUS", "PIN_CREATED", "PIN_DELETED", "ALM_PIN_CREATE", "ALM_PIN_BULK_CREATE", "ALM_PIN_UPDATE", "ALM_PIN_ROTATE", "ALM_PIN_BULK_ROTATE", "ALM_PIN_DELETE", "ALM_PIN_KEY_IN", "ALM_PIN_KEY_IN_FAILED", "BASIC_AUTH_SUCCESS", "BASIC_AUTH_FAILURE", "SAML_LOGIN_WEB", "LOGIN_WEB", "PASSWORDLESS_LOGIN_WEB", "PARTNER_LOGIN_WEB", "PARTNER_PASSWORDLESS_LOGIN_WEB", "SAML_LOGIN_FAILURE_WEB", "LOGIN_FAILURE_WEB", "RHOMBUS_KEY_LOGIN", "RHOMBUS_KEY_PASSWORDLESS_LOGIN", "RHOMBUS_KEY_SAML_LOGIN", "LOGOUT_WEB", "PARTNER_LOGOUT_WEB", "WEB_CONSOLE_ACCESS", "MOBILE_CONSOLE_ACCESS", "SAML_LOGIN_MOBILE", "PARTNER_LOGIN_MOBILE", "PARTNER_PASSWORDLESS_LOGIN_MOBILE", "LOGIN_MOBILE", "PASSWORDLESS_LOGIN_MOBILE", "SAML_LOGIN_FAILURE_MOBILE", "LOGIN_FAILURE_MOBILE", "LOGOUT_MOBILE", "PARTNER_LOGOUT_MOBILE", "MOBILE_ACCESS", "PARTNER_LOGIN_MOBIlE_REFRESH", "LOGIN_MOBIlE_REFRESH", "RHOMBUS_KEY_LOGIN_REFRESH", "CAMERA_WIFI_NETWORK_CHANGED", "CAMERA_FORCED_REBOOT", "AUDIO_GATEWAY_FORCED_REBOOT", "ENVIRONMENTAL_GATEWAY_FORCED_REBOOT", "DOORBELL_CAMERA_FORCED_REBOOT", "BADGE_READER_FORCED_REBOOT", "NVR_FORCED_REBOOT", "FIRMWARE_UPDATE_CAMERA", "DELETE_CAMERA", "DELETE_USER", "DELETE_LOCATION", "LOCATION_CREATE", "LOCATION_UPDATED", "DELETE_ROLE", "ERASE_CAMERA", "POLICY_UPDATE", "POLICY_DELETE", "POLICY_PAUSED_LOCATION", "POLICY_PAUSED_DEVICE", "POLICY_PAUSED_COMPONENT_COMPOSITE", "CREATE_POLICY_ADDENDUM", "DEVICE_REGISTERED", "PENDING_REGISTRATION_CREATE", "PENDING_REGISTRATION_REMOVED", "PENDING_REGISTRATION_UPDATED", "DEVICE_UPDATE", "DEVICE_SETTINGS_UPDATE", "REVERT_TO_DEFAULTS", "DEVICE_FEATURE_UPDATE", "DEVICE_ORG_REASSIGN", "CLAIMKEY_RENEWAL_CREATED", "LICENSES_CLAIMED", "LICENSES_RETURNED", "LICENSE_ASSIGNED", "LICENSE_CREATED", "LICENSE_UPDATED", "USER_UPDATE", "USER_CREATE", "USER_IMPORT", "BULK_PROVISION_CREDENTIALS", "ROLE_CREATE", "POLICY_CREATE", "PARTNER_CLIENT_CREATE", "PARTNER_CLIENT_DELETE", "PARTNER_CUSTOMIZE_CLIENT", "PARTNER_CUSTOMIZE_CLIENT_DEVICE", "ORG_UPDATE", "DELETE_ORG", "DISABLE_ORG", "CREATE_ORG", "ROLE_UPDATE", "USER_ROLE_UPDATE", "USER_EMAIL_UPDATE", "TIMELAPSE_CREATE", "TIMELAPSE_DELETE", "ALERT_DISMISS", "ALL_ALERT_DISMISS", "SAVED_CLIP_CREATE", "SAVED_CLIP_DELETE", "CLIP_GROUP_CREATED", "CLIP_GROUP_DELETE", "SHARED_CLIP_DELETE", "SHARED_CLIP_CREATE", "SHARED_LINK_SENT", "SHARED_LIVE_VIDEO_STREAM_WITH_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_WITHOUT_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_DELETE", "SHARED_VIDEOWALL_WITH_PASSWORD_CREATE", "SHARED_VIDEOWALL_WITHOUT_PASSWORD_CREATE", "SHARED_VIDEOWALL_DELETE", "RAW_HTTP_STREAM_CREATED", "RAW_HTTP_STREAM_DELETED", "SETUP_VIRTUAL_MFA_DEVICE", "DELETE_VIRTUAL_MFA_DEVICE", "SETUP_SCIM_API_ACCESS", "REVOKE_SCIM_API_ACCESS", "AUDIT_EXPORT", "COUNT_EXPORT", "DIAGNOSTIC_EXPORT", "INVENTORY_EXPORT", "USERS_EXPORT", "UPTIME_EXPORT", "ALM_EVENT_EXPORT", "SUPPORT_TICKET_OPEN", "RMA_OPEN", "FEEDBACK_CREATE", "SUPPORT_ACCESS_GRANT", "SUPPORT_ACCESS_REVOKE", "SUPPORT_PARTNER_ADD", "SUPPORT_PARTNER_REMOVE", "SUPPORT_PARTNER_LOGIN_ACCESS_EXPIRED", "SUPPORT_SEARCH_TICKETS", "ACCEPT_UAP", "ACCEPT_RHOMBUS_UAP", "ACCEPT_ALERTMONITORING_UAP", "CREATE_SEEKPOINT", "DELETE_CUSTOM_SEEKPOINT", "UPDATE_INTEGRATION_SAML", "UPDATE_INTEGRATION_SLACK", "UPDATE_INTEGRATION_SLACK_V2", "DELETE_INTEGRATION_SLACK_V2", "UPDATE_INTEGRATION_BOX", "DELETE_INTEGRATION_BOX", "UPDATE_INTEGRATION_GOOGLE", "DELETE_INTEGRATION_GOOGLE", "UPDATE_INTEGRATION_GOOGLE_V2", "DELETE_INTEGRATION_GOOGLE_V2", "UPDATE_INTEGRATION_PAGERDUTY", "DELETE_INTEGRATION_PAGERDUTY", "UPDATE_INTEGRATION_SERVICENOW", "DELETE_INTEGRATION_SERVICENOW", "UPDATE_INTEGRATION_OFFICE365", "DELETE_INTEGRATION_OFFICE365", "UPDATE_INTEGRATION_DROPBOX", "DELETE_INTEGRATION_DROPBOX", "UPDATE_INTEGRATION_SQUARE", "DELETE_INTEGRATION_SQUARE", "UPDATE_INTEGRATION_AWS", "DELETE_INTEGRATION_AWS", "UPDATE_INTEGRATION_HALO", "DELETE_INTEGRATION_HALO", "UPDATE_INTEGRATION_TRITON", "DELETE_INTEGRATION_TRITON", "UPDATE_INTEGRATION_WEBHOOK", "DELETE_INTEGRATION_WEBHOOK", "UPDATE_INTEGRATION_EMAIL", "DELETE_INTEGRATION_EMAIL", "UPDATE_INTEGRATION_MATTERMOST", "DELETE_INTEGRATION_MATTERMOST", "UPDATE_INTEGRATION_OPENPATH", "DELETE_INTEGRATION_OPENPATH", "UPDATE_INTEGRATION_AVIGILON_ALTA", "DELETE_INTEGRATION_AVIGILON_ALTA", "UPDATE_INTEGRATION_DICE", "DELETE_INTEGRATION_DICE", "UPDATE_INTEGRATION_LUMEO", "DELETE_INTEGRATION_LUMEO", "UPDATE_INTEGRATION_DEVICE", "DELETE_INTEGRATION_DEVICE", "UPDATE_INTEGRATION_GUESTMANAGEMENT", "DELETE_INTEGRATION_GUESTMANAGEMENT", "UPDATE_GUESTMANAGEMENT_SETTINGS", "DELETE_GUESTMANAGEMENT_SETTINGS", "INVITE_GUEST", "CREATE_GUEST", "CHECKIN_GUEST", "CHECKOUT_GUEST", "UPDATE_GUEST", "DELETE_GUEST", "ACTIVATE_KIOSK", "UPDATE_INTEGRATION_OMNIALERT", "DELETE_INTEGRATION_OMNIALERT", "UPDATE_INTEGRATION_OPENTECHALLIANCE", "DELETE_INTEGRATION_OPENTECHALLIANCE", "UPDATE_INTEGRATION_TOAST", "DELETE_INTEGRATION_TOAST", "UPDATE_INTEGRATION_KISI", "DELETE_INTEGRATION_KISI", "UPDATE_INTEGRATION_BRIVO", "DELETE_INTEGRATION_BRIVO", "UPDATE_INTEGRATION_BUTTERFLYMX", "DELETE_INTEGRATION_BUTTERFLYMX", "UPDATE_INTEGRATION_ENVOY", "DELETE_INTEGRATION_ENVOY", "CREATE_ENVOY_INVITE", "UPDATE_INTEGRATION_SALTO", "UPDATE_INTEGRATION_PDK", "DELETE_INTEGRATION_PDK", "UPDATE_INTEGRATION_GENEA", "DELETE_INTEGRATION_GENEA", "UPDATE_INTEGRATION_MICROSOFTTEAMS", "DELETE_INTEGRATION_MICROSOFTTEAMS", "UPDATE_INTEGRATION_AMT", "DELETE_INTEGRATION_AMT", "UPDATE_INTEGRATION_PLACEOS", "DELETE_INTEGRATION_PLACEOS", "UPDATE_INTEGRATION_INTUIFACE", "DELETE_INTEGRATION_INTUIFACE", "UPDATE_INTEGRATION_INFORMACAST", "DELETE_INTEGRATION_INFORMACAST", "UPDATE_INTEGRATION_BOULEVARD", "DELETE_INTEGRATION_BOULEVARD", "UPDATE_INTEGRATION_INNERRANGE", "DELETE_INTEGRATION_INNERRANGE", "UPDATE_INTEGRATION_HONEYWELL_ELEMENTS", "DELETE_INTEGRATION_HONEYWELL_ELEMENTS", "UPDATE_INTEGRATION_HONEYWELL_ONGUARD", "DELETE_INTEGRATION_HONEYWELL_ONGUARD", "UPDATE_INTEGRATION_SHELLY", "DELETE_INTEGRATION_SHELLY", "SEND_INTEGRATION_COMMAND_SHELLY", "UPDATE_INTEGRATION_FLIC", "DELETE_INTEGRATION_FLIC", "UPDATE_INTEGRATION_NINEONEONECELLULAR", "DELETE_INTEGRATION_NINEONEONECELLULAR", "UPDATE_INTEGRATION_PIMLOC", "DELETE_INTEGRATION_PIMLOC", "UPDATE_INTEGRATION_RAPTOR", "DELETE_INTEGRATION_RAPTOR", "UPDATE_INTEGRATION_LLM", "DELETE_INTEGRATION_LLM", "UPDATE_INTEGRATION_NOONLIGHT", "UPDATE_INTEGRATION_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING_LOCATION", "CREATE_ALARM_MONITORING_SETTINGS", "UPDATE_ALARM_MONITORING_SETTINGS", "DELETE_ALARM_MONITORING_SETTINGS", "ENABLE_ALARM_MONITORING_SETTINGS", "DISABLE_ALARM_MONITORING_SETTINGS", "ALM_CANCEL_MANUAL_ARM", "ALM_CANCEL_MANUAL_DISARM", "ALM_THREAT_QUALIFICATION_CREATE", "ALM_THREAT_QUALIFICATION_UPDATE", "ALM_THREAT_QUALIFICATION_DELETE", "REPORT_VEHICLE_EVENT", "API_TOKEN_REQUEST", "API_TOKEN_REVOKE", "API_INVOCATION", "API_OAUTH_TOKEN_REQUEST", "API_OAUTH_TOKEN_REFRESH", "API_OAUTH_TOKEN_REVOKE", "API_OAUTH_INVOCATION", "API_OAUTH_SUBMIT_APPLICATION", "API_OAUTH_UPDATE_APPLICATION", "API_OAUTH_DELETE_APPLICATION", "API_OAUTH_AUTHORIZE", "VIDEO_WALL_CREATE", "VIDEO_WALL_UPDATE", "VIDEO_WALL_DELETE", "VIEW_SHARE_TIMELAPSE", "VIEW_SHARE_CLIP", "VIEW_SHARE_STREAM", "VIEW_SHARE_VIDEOWALL", "VIEW_CAMERA_VOD", "CAMERA_POLICY_UPDATE", "CAMERA_POLICY_CREATE", "CAMERA_POLICY_DELETE", "TAG_POLICY_UPDATE", "TAG_POLICY_CREATE", "TAG_POLICY_DELETE", "CLIMATE_POLICY_UPDATE", "CLIMATE_POLICY_CREATE", "CLIMATE_POLICY_DELETE", "DOOR_POLICY_UPDATE", "DOOR_POLICY_CREATE", "DOOR_POLICY_DELETE", "DOOR_SCHEDULE_EXCEPTION_UPDATE", "DOOR_SCHEDULE_EXCEPTION_CREATE", "DOOR_SCHEDULE_EXCEPTION_DELETE", "ACCESS_CONTROLLED_DOOR_POLICY_UPDATE", "ACCESS_CONTROLLED_DOOR_POLICY_CREATE", "ACCESS_CONTROLLED_DOOR_POLICY_DELETE", "VIDEO_INTERCOM_POLICY_UPDATE", "VIDEO_INTERCOM_POLICY_CREATE", "VIDEO_INTERCOM_POLICY_DELETE", "OCCUPANCY_POLICY_UPDATE", "OCCUPANCY_POLICY_CREATE", "OCCUPANCY_POLICY_DELETE", "AUDIO_POLICY_UPDATE", "AUDIO_POLICY_CREATE", "AUDIO_POLICY_DELETE", "SCHEDULE_CREATE", "SCHEDULE_DELETE", "SCHEDULE_UPDATE", "CUSTOM_EVENT_CREATE", "CUSTOM_EVENT_DELETE", "CUSTOM_EVENT_UPDATE", "CUSTOM_EVENT_TOS_ACCEPTED", "CUSTOM_EVENT_TOS_REVOKED", "SUBSCRIPTION_SETUP_INTENT_CREATE", "SUBSCRIPTION_CREATE", "SUBSCRIPTION_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_UPDATE", "SUBSCRIPTION_MAX_SPEND_UPDATE", "SUBSCRIPTION_CHECKOUT_SESSION_CREATE", "UPLOAD_FLOORPLAN", "ORG_AUDIO_RECORD_UPDATE", "ORG_AUDIO_ANALYSIS_UPDATE", "ORG_LLM_USAGE_UPDATE", "ORG_LLM_USAGE_ENABLED", "ORG_LLM_USAGE_DISABLED", "DOOR_ACCESS_UNLOCK", "RHOMBUS_KEY_DOOR_UNLOCK", "ELEVATOR_ACCESS_UNLOCK", "RHOMBUS_KEY_ELEVATOR_UNLOCK", "VIDEO_INTERCOM_TALK", "RHOMBUS_KEY_UPDATE_APP_SETTINGS", "UPLOAD_ACCESS_CONTROLLED_DOOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR_LANDING", "UPLOAD_USER_PROFILE_PICTURE", "ACCESS_GRANT_CREATE", "ACCESS_GRANT_UPDATE", "ACCESS_GRANT_DELETE", "ACCESS_REVOCATION_CREATE", "ACCESS_REVOCATION_UPDATE", "ACCESS_REVOCATION_DELETE", "ACCESS_CONTROLLED_DOOR_CREATE", "ACCESS_CONTROLLED_DOOR_UPDATE", "ACCESS_CONTROLLED_DOOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_CREATE", "ACCESS_CONTROLLED_ELEVATOR_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_CREATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_CREATE", "AC_CRED_RHOMBUS_SECURE_CSN_UPDATE", "AC_CRED_RHOMBUS_SECURE_CSN_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_REVOKED", "AC_CRED_RHOMBUS_SECURE_CSN_ASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_SUSPEND", "AC_CRED_RHOMBUS_SECURE_CSN_UNSUSPEND", "AC_CRED_STANDARD_CSN_CREATE", "AC_CRED_STANDARD_CSN_UPDATE", "AC_CRED_STANDARD_CSN_DELETE", "AC_CRED_STANDARD_CSN_REVOKED", "AC_CRED_STANDARD_CSN_ASSIGN", "AC_CRED_STANDARD_CSN_UNASSIGN", "AC_CRED_STANDARD_CSN_SUSPEND", "AC_CRED_STANDARD_CSN_UNSUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_CREATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_UPDATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_DELETE", "AC_CRED_RHOMBUS_SECURE_MOBILE_REVOKED", "AC_CRED_RHOMBUS_SECURE_MOBILE_ASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_SUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNSUSPEND", "AC_CRED_PIN_CREATE", "AC_CRED_PIN_BULK_CREATE", "AC_CRED_PIN_UPDATE", "AC_CRED_PIN_ROTATE", "AC_CRED_PIN_BULK_ROTATE", "AC_CRED_PIN_DELETE", "AC_CRED_PIN_REVOKED", "AC_CRED_PIN_ASSIGN", "AC_CRED_PIN_UNASSIGN", "AC_CRED_PIN_SUSPEND", "AC_CRED_PIN_UNSUSPEND", "AC_CRED_QR_CREATE", "AC_CRED_QR_REVOKED", "AC_CRED_QR_DELETE", "AC_CRED_QR_SUSPEND", "AC_CRED_QR_UNSUSPEND", "AC_CRED_WIEGAND_CREATE", "AC_CRED_WIEGAND_UPDATE", "AC_CRED_WIEGAND_DELETE", "AC_CRED_WIEGAND_REVOKED", "AC_CRED_WIEGAND_ASSIGN", "AC_CRED_WIEGAND_UNASSIGN", "AC_CRED_WIEGAND_SUSPEND", "AC_CRED_WIEGAND_UNSUSPEND", "AC_CRED_NOTE_UPDATE", "AC_LOCKDOWN_PLAN_CREATED", "AC_LOCKDOWN_PLAN_UPDATED", "AC_LOCKDOWN_PLAN_DELETED", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_LOCKDOWN_PLAN_SWITCHED", "AC_COMPONENT_POWER_CYCLE", "AC_DOOR_STATE_OVERRIDE_APPLIED", "AC_DOOR_STATE_OVERRIDE_CANCELLED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_APPLIED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_CANCELLED", "AC_GUEST_PASS_CREATE", "AC_GUEST_PASS_UPDATE", "AC_GUEST_PASS_SUSPEND", "AC_GUEST_PASS_UNSUSPEND", "AC_GUEST_PASS_EXPIRE", "AC_GUEST_PASS_DELETE", "SCIM_GET_ALL_USERS", "SCIM_POST_CREATE_USER", "SCIM_PUT_UPDATE_USER", "SCIM_PATCH_UPDATE_USER", "SCIM_GET_USER_BY_ID", "SCIM_DELETE_USER_BY_ID", "SCIM_GET_ALL_GROUPS", "SCIM_POST_CREATE_GROUP", "SCIM_PUT_UPDATE_GROUP", "SCIM_PATCH_UPDATE_GROUP", "SCIM_GET_GROUP_BY_ID", "SCIM_DELETE_GROUP_BY_ID", "CREATE_ACCESS_CONTROL_GROUP", "UPDATE_ACCESS_CONTROL_GROUP", "DELETE_ACCESS_CONTROL_GROUP", "RULE_CREATE", "RULE_DELETE", "RULE_UPDATE", "RULE_PAUSE", "UPLOAD_FACES", "UPDATE_FACE", "REPORT_FACE_EVENT", "FACE_EVENT_UPDATED", "FACE_EVENT_DELETED", "FACE_PERSON_CREATED", "FACE_PERSON_UPDATED", "FACE_PERSON_DELETED", "FACE_MATCHMAKER_CREATED", "FACE_MATCHMAKER_DELETED", "FACE_MATCHMAKER_UPLOADED", "FACE_MATCHING_CONFIG_UPDATED", "EXPUNGE_FACES_ORG", "EXPUNGE_VEHICLES_ORG", "DEVICE_NETWORK_CONFIGURATION_CHANGE", "KIOSK_UPDATED", "KIOSK_DELETED", "KIOSK_CREATED", "GUEST_DELETED", "UPDATE_APERIO_FIRMWARE", "UPDATE_INTEGRATION_APERIO", "DELETE_INTEGRATION_APERIO", "APERIO_GATEWAY_CREATE", "APERIO_DOORS_CREATE", "APERIO_GATEWAY_REBOOT", "APERIO_DTC_CLEAR", "THIRD_PARTY_CAMERA_CREATE", "THIRD_PARTY_CAMERA_DELETE", "THIRD_PARTY_CAMERA_UPDATED", "THIRD_PARTY_CAMERA_ASSIGNED_TO_CORE", "THIRD_PARTY_CAMERA_ASSIGNED_TO_LITE", "THIRD_PARTY_CAMERA_UNASSIGNED", "THIRD_PARTY_CAMERA_PASSWORD_CREATE", "THIRD_PARTY_CAMERA_PASSWORD_DELTE", "THIRD_PARTY_CAMERA_PASSWORD_DELETE", "CREATE_CHATBOT_CONFIG", "UPDATE_CHATBOT_CONFIG", "DELETE_CHATBOT_CONFIG", "SUPPORT_AUTHORITY_UPDATE", "SUPPORT_AUTHORITY_LOGOUT_ALL", "DELETE_DOOR_CONTROLLER", "DELETE_DOORBELL_CAMERA", "DELETE_BADGE_READER", "DELETE_ENVIRONMENTAL_GATEWAY", "AC_LOCKDOWN_TEST_MODE_ENABLED", "AC_LOCKDOWN_TEST_MODE_DISABLED", "CLOUD_ARCHIVING_CONFIG_UPDATE", "CLOUD_ARCHIVING_CONFIG_DELETE", "SCIM_UPDATE_SETTINGS", "INCIDENT_REPORT_CREATE", "INCIDENT_REPORT_DELETE", "INCIDENT_REPORT_UPDATE", "INCIDENT_REPORT_SHARE", "DATA_RETENTION_SETTINGS_UPDATE", "MSP_DESIGNATION_SYNC", "MSP_DESIGNATION_ACTIVATED", "MSP_DESIGNATION_REVOKED", "MSP_CLIENT_ADOPT", "MSP_CLIENT_RELEASE", "MSP_CLIENT_DEACTIVATE", "MSP_CLIENT_POLICY_UPDATE", "MSP_LICENSE_ASSIGN", "MSP_LICENSE_RECLAIM", "MSP_HARDWARE_MOVE", "UNKNOWN" ] }, "AuditRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "auditEvent" : { "$ref" : "#/components/schemas/SimpleAuditEventType" }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "AuthDecisionSourceEnum" : { "type" : "string", "enum" : [ "ACCESS_GRANT", "ACCESS_REVOCATION", "LOCKDOWN", "FIRST_IN_SETTINGS", "CONFIG", "ADMIN", "PRIVACY", "ERROR", "UNKNOWN" ] }, "AutomatedPrompt" : { "type" : "object", "description" : "Selective update applied to the automated job settings.", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "followUpActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FollowUpAction" }, "nullable" : true }, "frequency" : { "$ref" : "#/components/schemas/PromptFrequency" }, "invokeAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "prompt" : { "type" : "string", "nullable" : true }, "responseTemplate" : { "type" : "string", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AuxiliaryEnumType" : { "type" : "string", "enum" : [ "integrated_generic_input", "integrated_generic_relay" ] }, "AuxiliaryInputPhysicalPortEnumType" : { "type" : "string", "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] }, "AuxiliaryInputPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/AuxiliaryInputPhysicalPortEnumType" }, "supervisionConfiguration" : { "$ref" : "#/components/schemas/PortSupervisionConfigurationType" } } }, "AuxiliaryRelayPhysicalPortEnumType" : { "type" : "string", "enum" : [ "GPIO_OUTPUT" ] }, "AuxiliaryRelayPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/AuxiliaryRelayPhysicalPortEnumType" } } }, "AvigilonAltaType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorToCameraMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "eventToWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "eventToWebhookMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/WebhookMapEntry" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "AwsSettings" : { "type" : "object", "properties" : { "accessKey" : { "type" : "string", "nullable" : true }, "bucketName" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "secretKey" : { "type" : "string", "nullable" : true } } }, "AxisRange" : { "type" : "object", "properties" : { "max" : { "type" : "number", "format" : "double", "nullable" : true }, "min" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "BackblazeSettings" : { "type" : "object", "properties" : { "applicationKey" : { "type" : "string", "nullable" : true }, "applicationKeyId" : { "type" : "string", "nullable" : true }, "bucketName" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true } } }, "BackgroundCheckEnum" : { "type" : "string", "enum" : [ "CLEARED", "NEEDS_ATTENTION" ] }, "BadgeFaceVerificationModeEnum" : { "type" : "string", "enum" : [ "OFF", "SHADOW", "SUPERVISED", "AUTO" ] }, "BadgeIntegrationDefaultOptions" : { "type" : "object", "nullable" : true, "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "defaultOptionsEnabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "BadgeIntegrationDoorInfoType" : { "type" : "object", "nullable" : true, "properties" : { "assignedCameraList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "clipDuration" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorName" : { "type" : "string", "nullable" : true }, "leadingSeconds" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlock" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "BadgeIntegrationRuleTriggerType" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "BadgeIntegrationSettings" : { "type" : "object", "nullable" : true, "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "placeId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "placeName" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "BadgeTemplate" : { "type" : "object", "description" : "The updated badge template", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "elements" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseBadgeTemplateElement" }, "nullable" : true }, "front" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "portrait" : { "type" : "boolean", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "version" : { "type" : "string", "nullable" : true } } }, "BadgeTemplateElementEnum" : { "type" : "string", "enum" : [ "CUSTOM_TEXT", "USER_METADATA", "USER_CUSTOM_METADATA", "CUSTOM_IMAGE", "USER_PROFILE_PHOTO" ] }, "BadgeTemplateImage" : { "type" : "object", "description" : "The updated badge template image metadata.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "imageS3Key" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originalFileName" : { "type" : "string", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BadgeTemplateImageSelectiveUpdate" : { "type" : "object", "description" : "The selective update containing the fields to update for the badge template image.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "imageS3Key" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originalFileName" : { "type" : "string", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BadgeTemplateSelectiveUpdate" : { "type" : "object", "description" : "The selective update containing the fields to update.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "elements" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseBadgeTemplateElement" }, "nullable" : true }, "front" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "portrait" : { "type" : "boolean", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "version" : { "type" : "string", "nullable" : true } } }, "Badgereader_DeleteBadgeReaderWSRequest" : { "type" : "object", "description" : "Request to delete a badge reader device.", "properties" : { "badgeReaderUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Whether to mummify the device instead of hard delete", "example" : false, "nullable" : true } }, "required" : [ "badgeReaderUuid", "mummify" ] }, "Badgereader_DeleteBadgeReaderWSResponse" : { "type" : "object", "description" : "Response from deleting a badge reader device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Badgereader_GetBadgeReaderConfigWSResponse" : { "type" : "object", "description" : "Response containing badge reader configuration.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Badgereader_GetBadgeReaderFullStateWSResponse" : { "type" : "object", "description" : "Response containing full state information for a badge reader.", "properties" : { "fullState" : { "$ref" : "#/components/schemas/FullDeviceStateType" } } }, "Badgereader_GetBadgeReaderMinimalStateListWSResponse" : { "type" : "object", "description" : "Response containing minimal state information for all badge readers in organization.", "properties" : { "minimalStates" : { "type" : "array", "description" : "List of minimal device state information for badge readers", "items" : { "$ref" : "#/components/schemas/MinimalDeviceStateType" }, "nullable" : true } } }, "Badgereader_RebootBadgeReaderWSRequest" : { "type" : "object", "description" : "Request to reboot a badge reader device.", "properties" : { "badgeReaderUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "badgeReaderUuid" ] }, "Badgereader_UpdateBadgeReaderConfigWSRequest" : { "type" : "object", "description" : "Request to update badge reader configuration.", "properties" : { "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" } } }, "Badgereader_UpdateBadgeReaderDetailsWSRequest" : { "type" : "object", "description" : "Request to update badge reader device details.", "properties" : { "description" : { "type" : "string", "description" : "Optional description for the badge reader", "example" : "Primary access point for employees", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "description" : "Optional direction in radians", "example" : 1.5708, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Optional floor number", "example" : 1, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Optional latitude coordinate", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Optional longitude coordinate", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Optional name for the badge reader", "example" : "Main Entrance Reader", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true } } }, "BaseAccessStateOverride" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" } } }, "BaseAccessStateOverride_Minimal" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ManualAccessStateChangeEnum_Minimal" } } }, "BaseApiResponse" : { "type" : "object", "description" : "Base response object denoting success, or failure with a reason, for an endpoint.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "BaseBadgeTemplateElement" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/CustomTextElement" }, { "$ref" : "#/components/schemas/UserMetadataTextElement" }, { "$ref" : "#/components/schemas/UserCustomMetadataTextElement" }, { "$ref" : "#/components/schemas/CustomImageElement" }, { "$ref" : "#/components/schemas/UserProfilePhotoElement" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, "x" : { "type" : "integer", "format" : "int32", "nullable" : true }, "y" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "BaseCatalogItem" : { "type" : "object", "discriminator" : { "propertyName" : "productType" }, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "BaseClaimKey" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "properties" : { "claimEndDate" : { "type" : "string", "format" : "date-time", "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", "nullable" : true }, "claimStartDate" : { "type" : "string", "format" : "date-time", "description" : "Date/time when claiming of licenses represented by this claim key started.", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "endDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "expirationEmailState" : { "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" }, "gracePeriodEndDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "maskedClaimCode" : { "type" : "string", "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "renewedByClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "requestId" : { "type" : "string", "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", "nullable" : true }, "returnHistory" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimKeyReturnEvent" }, "nullable" : true }, "state" : { "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ClaimKeyTypeEnum" }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseComponentType" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" }, { "$ref" : "#/components/schemas/OsdpDoorReaderType" }, { "$ref" : "#/components/schemas/WiegandDoorReaderType" }, { "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" }, { "$ref" : "#/components/schemas/IntegratedRequestToExitType" }, { "$ref" : "#/components/schemas/IntegratedDoorRelayType" }, { "$ref" : "#/components/schemas/IntegratedGenericRelayType" }, { "$ref" : "#/components/schemas/IntegratedGenericInputType" }, { "$ref" : "#/components/schemas/IntegratedGenericButtonType" }, { "$ref" : "#/components/schemas/SchlageInputButton" }, { "$ref" : "#/components/schemas/AperioActivatorButton" }, { "$ref" : "#/components/schemas/AperioGateway" }, { "$ref" : "#/components/schemas/AperioDoorReader" }, { "$ref" : "#/components/schemas/AperioDoorExtension" }, { "$ref" : "#/components/schemas/AperioDoorRelay" }, { "$ref" : "#/components/schemas/AperioDoorPositionIndicator" }, { "$ref" : "#/components/schemas/AperioRs485Gateway" }, { "$ref" : "#/components/schemas/AperioRs485DoorReader" }, { "$ref" : "#/components/schemas/AperioRs485DoorRelay" }, { "$ref" : "#/components/schemas/AperioRs485DoorPositionIndicator" }, { "$ref" : "#/components/schemas/AperioRs485DoorRequestToExit" }, { "$ref" : "#/components/schemas/AperioRs485DoorExtension" }, { "$ref" : "#/components/schemas/SchlageRs485Gateway" }, { "$ref" : "#/components/schemas/SchlageRs485DoorReader" }, { "$ref" : "#/components/schemas/SchlageRs485DoorExtension" }, { "$ref" : "#/components/schemas/SchlageRs485DoorRelay" }, { "$ref" : "#/components/schemas/SchlageRs485DoorPositionIndicator" }, { "$ref" : "#/components/schemas/SchlageRs485DoorRequestToExit" } ], "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseEventOriginator" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" }, { "$ref" : "#/components/schemas/ApiTokenEventOriginator" }, { "$ref" : "#/components/schemas/UserEventOriginator" }, { "$ref" : "#/components/schemas/RuleEventOriginator" }, { "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" }, { "$ref" : "#/components/schemas/GuestPassEventOriginator" }, { "$ref" : "#/components/schemas/DeviceServiceEventOriginator" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, "BaseEventOriginator_Minimal" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" }, { "$ref" : "#/components/schemas/ApiTokenEventOriginator" }, { "$ref" : "#/components/schemas/UserEventOriginator" }, { "$ref" : "#/components/schemas/RuleEventOriginator" }, { "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" }, { "$ref" : "#/components/schemas/GuestPassEventOriginator" }, { "$ref" : "#/components/schemas/DeviceServiceEventOriginator" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum_Minimal" } } }, "BaseFirstInReset" : { "type" : "object", "description" : "Optional list of first-in reset configurations.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/DailyFirstInReset" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/FirstInResetEnum" } } }, "BaseLicenseType" : { "type" : "object", "description" : "List of licenses found by claim key", "discriminator" : { "propertyName" : "productType" }, "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseLocationLockdownEventOriginator" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "properties" : { "type" : { "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" } } }, "BaseLockdownPlanType" : { "type" : "object", "description" : "The requested lockdown plan.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/LocationLockdownPlanType" } ], "properties" : { "activationPlan" : { "$ref" : "#/components/schemas/LockdownActivationPlanType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deactivationPlan" : { "$ref" : "#/components/schemas/LockdownDeactivationPlanType" }, "defaultLockdownState" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "doorLockdownStateMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "physicalAccess" : { "$ref" : "#/components/schemas/LockdownPhysicalAccessType" }, "scopeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "testPlan" : { "$ref" : "#/components/schemas/LockdownTestPlanType" }, "type" : { "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseLockdownStateEventType" : { "type" : "object", "description" : "List of lockdown events found for the specified location.", "discriminator" : { "propertyName" : "type" }, "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" }, "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, "BasePolicyAlertType" : { "type" : "object", "description" : "The requested policy alert", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/PolicyAlertV2Type" }, { "$ref" : "#/components/schemas/AccessControlledDoorPolicyAlertType" } ], "properties" : { "alertMonitoringThreatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "alertMonitoringVerified" : { "type" : "boolean", "nullable" : true }, "archived" : { "type" : "boolean", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/ApiClientTypeEnum" }, "clipLocationMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "nullable" : true }, "clipLocationMapV2" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "delayedProcessing" : { "type" : "boolean", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "finalized" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "notificationSent" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyAlertTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saved" : { "type" : "boolean", "nullable" : true }, "serverReceivedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "shared" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "textDescription" : { "type" : "string", "description" : "Natural language description of the alert", "nullable" : true }, "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "thumbnailLocationV2" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/PolicyAlertEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseRuleTriggerType" : { "type" : "object", "discriminator" : { "mapping" : { "ALERT_MONITORING_EVENT" : "#/components/schemas/AlertMonitoringRuleTriggerType", "AUDIT_EVENT" : "#/components/schemas/AuditRuleTriggerType", "BADGE_INTEGRATION_EVENT" : "#/components/schemas/BadgeIntegrationRuleTriggerType", "BUTTON_INTEGRATION_EVENT" : "#/components/schemas/ButtonIntegrationRuleTriggerType", "CUSTOM_LLM_EVENT" : "#/components/schemas/CustomLLMEventRuleTriggerType", "DEVICE_ACTIVITY_EVENT" : "#/components/schemas/DeviceActivityRuleTriggerType", "DIAGNOSTIC_EVENT" : "#/components/schemas/DiagnosticRuleTriggerType", "INCOMING_WEBHOOK_EVENT" : "#/components/schemas/IncomingWebhookRuleTriggerType", "LOCATION_LOCKDOWN_ACTIVATED_EVENT" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType", "LOCATION_LOCKDOWN_DEACTIVATED_EVENT" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType", "RECURRING_EVENT" : "#/components/schemas/RecurringRuleTriggerType", "SCHEDULED_EVENT" : "#/components/schemas/ScheduledRuleTriggerType", "SHELLY_INTEGRATION_EVENT" : "#/components/schemas/ShellyIntegrationRuleTriggerType", "VISION_LLM_EVENT" : "#/components/schemas/VisionLLMRuleTriggerType" }, "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/DeviceActivityRuleTriggerType" }, { "$ref" : "#/components/schemas/AuditRuleTriggerType" }, { "$ref" : "#/components/schemas/AlertMonitoringRuleTriggerType" }, { "$ref" : "#/components/schemas/DiagnosticRuleTriggerType" }, { "$ref" : "#/components/schemas/BadgeIntegrationRuleTriggerType" }, { "$ref" : "#/components/schemas/ScheduledRuleTriggerType" }, { "$ref" : "#/components/schemas/VisionLLMRuleTriggerType" }, { "$ref" : "#/components/schemas/RecurringRuleTriggerType" }, { "$ref" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType" }, { "$ref" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType" }, { "$ref" : "#/components/schemas/CustomLLMEventRuleTriggerType" }, { "$ref" : "#/components/schemas/ButtonIntegrationRuleTriggerType" }, { "$ref" : "#/components/schemas/ShellyIntegrationRuleTriggerType" }, { "$ref" : "#/components/schemas/IncomingWebhookRuleTriggerType" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } }, "title" : "RuleTriggerType" }, "BaseSavedScheduleType" : { "type" : "object", "description" : "Schedule for the shared live stream", "discriminator" : { "propertyName" : "strategy" }, "oneOf" : [ { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, { "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" }, { "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" }, { "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" } ], "properties" : { "internalWriteOnly" : { "type" : "boolean", "nullable" : true }, "mutable" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "oneTimeUse" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "strategy" : { "$ref" : "#/components/schemas/ScheduleStrategyEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseSavedScheduleType_Minimal" : { "type" : "object", "description" : "List of schedules", "discriminator" : { "propertyName" : "strategy" }, "oneOf" : [ { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, { "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" }, { "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" }, { "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" } ], "properties" : { "internalWriteOnly" : { "type" : "boolean", "nullable" : true }, "mutable" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "oneTimeUse" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "strategy" : { "$ref" : "#/components/schemas/ScheduleStrategyEnum_Minimal" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BaseTimelineEntry" : { "type" : "object", "description" : "An entry on an incident report timeline.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/SnapshotTimelineEntry" }, { "$ref" : "#/components/schemas/EventTimelineEntry" }, { "$ref" : "#/components/schemas/ClipTimelineEntry" }, { "$ref" : "#/components/schemas/PolicyAlertTimelineEntry" }, { "$ref" : "#/components/schemas/ThreatCaseEventTimelineEntry" } ], "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "imageKey" : { "type" : "string", "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, "location" : { "$ref" : "#/components/schemas/TimelineEntryLocation" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "systemGenerated" : { "type" : "boolean", "description" : "Whether the entry was generated by the system rather than created by a user.", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/TimelineEntryTypeEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BasicResponseEnumType" : { "type" : "string", "enum" : [ "ERROR", "SUCCESS" ] }, "BatchRegistrationTokenUsageResult" : { "type" : "object", "description" : "List of batch registration token usage results", "properties" : { "di" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hi" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rs" : { "type" : "string", "nullable" : true }, "ts" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "BehaviorEventTypeEnum" : { "type" : "string", "enum" : [ "STARTED", "PROGRESS", "SUSPENDED", "RESUMED", "COMPLETED", "FAILED", "CANCELED", "REJECTED", "UNKNOWN" ] }, "Billing_CreateCheckoutSessionWSRequest" : { "type" : "object", "properties" : { "invoiceId" : { "type" : "string", "nullable" : true } } }, "Billing_CreateCheckoutSessionWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sessionId" : { "type" : "string", "nullable" : true }, "sessionUrl" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_CreateSubscriptionWSRequest" : { "type" : "object", "properties" : { "billingCycleTimezone" : { "type" : "string", "nullable" : true }, "maxSpendPerMonth" : { "type" : "integer", "format" : "int64", "nullable" : true }, "paymentMethodId" : { "type" : "string", "nullable" : true }, "termsOfServiceAccepted" : { "type" : "boolean", "nullable" : true } } }, "Billing_CreateSubscriptionWSResponse" : { "type" : "object", "properties" : { "customerId" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "paymentMethodId" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "subscriptionId" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_CustomEventsMonthlyBreakdownWSRequest" : { "type" : "object", "properties" : { "date" : { "type" : "string", "nullable" : true } } }, "Billing_CustomEventsMonthlyBreakdownWSResponse" : { "type" : "object", "properties" : { "breakdowns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" : { "type" : "object", "properties" : { "eventCount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "promptName" : { "type" : "string", "nullable" : true }, "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Billing_DeletePaymentMethodWSRequest" : { "type" : "object", "properties" : { "paymentMethodId" : { "type" : "string", "nullable" : true } } }, "Billing_DeletePaymentMethodWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "removed" : { "type" : "boolean", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_FreeCreditEligibilityWSResponse" : { "type" : "object", "properties" : { "customEvents" : { "$ref" : "#/components/schemas/Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" : { "type" : "object", "properties" : { "freeCreditAmountCents" : { "type" : "integer", "format" : "int32", "nullable" : true }, "freeCreditRemainingCents" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hasSubscription" : { "type" : "boolean", "nullable" : true }, "isEligibleForVoucher" : { "type" : "boolean", "nullable" : true }, "isOnVoucher" : { "type" : "boolean", "nullable" : true }, "isVoucherExhausted" : { "type" : "boolean", "nullable" : true } } }, "Billing_GetCustomerInformationWSRequest" : { "type" : "object" }, "Billing_GetCustomerInformationWSResponse" : { "type" : "object", "properties" : { "addressCity" : { "type" : "string", "nullable" : true }, "addressCountry" : { "type" : "string", "nullable" : true }, "addressLine1" : { "type" : "string", "nullable" : true }, "addressLine2" : { "type" : "string", "nullable" : true }, "addressPostalCode" : { "type" : "string", "nullable" : true }, "addressState" : { "type" : "string", "nullable" : true }, "businessName" : { "type" : "string", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "individualName" : { "type" : "string", "nullable" : true }, "phone" : { "type" : "string", "nullable" : true }, "termsOfServiceAcceptanceTimestamp" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetInvoicesWSRequest" : { "type" : "object", "properties" : { "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startingAfter" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/Billing_InvoiceStatus" }, "subscriptionId" : { "type" : "string", "nullable" : true } } }, "Billing_GetInvoicesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "hasMore" : { "type" : "boolean", "nullable" : true }, "invoices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetInvoicesWSResponse_Invoice" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetInvoicesWSResponse_Invoice" : { "type" : "object", "properties" : { "amount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "amountDue" : { "type" : "integer", "format" : "int64", "nullable" : true }, "amountPaid" : { "type" : "integer", "format" : "int64", "nullable" : true }, "created" : { "type" : "integer", "format" : "int64", "nullable" : true }, "currency" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "dueDate" : { "type" : "integer", "format" : "int64", "nullable" : true }, "hostedInvoiceUrl" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "invoicePdf" : { "type" : "string", "nullable" : true }, "number" : { "type" : "string", "nullable" : true }, "periodEnd" : { "type" : "integer", "format" : "int64", "nullable" : true }, "periodStart" : { "type" : "integer", "format" : "int64", "nullable" : true }, "productName" : { "type" : "string", "nullable" : true }, "quantity" : { "type" : "integer", "format" : "int64", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "subtotal" : { "type" : "integer", "format" : "int64", "nullable" : true }, "tax" : { "type" : "integer", "format" : "int64", "nullable" : true }, "total" : { "type" : "integer", "format" : "int64", "nullable" : true }, "usageDescriptions" : { "type" : "string", "nullable" : true } } }, "Billing_GetMetersWSRequest" : { "type" : "object" }, "Billing_GetMetersWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "meters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetMetersWSResponse_Meter" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetMetersWSResponse_Meter" : { "type" : "object", "properties" : { "archived" : { "type" : "boolean", "nullable" : true }, "created" : { "type" : "integer", "format" : "int64", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "eventName" : { "type" : "string", "nullable" : true }, "eventTimeWindow" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true } } }, "Billing_GetPaymentMethodsWSRequest" : { "type" : "object" }, "Billing_GetPaymentMethodsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "paymentMethods" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetPaymentMethodsWSResponse_PaymentMethod" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetPaymentMethodsWSResponse_PaymentMethod" : { "type" : "object", "properties" : { "brand" : { "type" : "string", "nullable" : true }, "default" : { "type" : "boolean", "nullable" : true }, "displayBrand" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "last4" : { "type" : "string", "nullable" : true } } }, "Billing_GetProductsWSRequest" : { "type" : "object" }, "Billing_GetProductsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "products" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Product" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetProductsWSResponse_Price" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "nullable" : true }, "billingScheme" : { "type" : "string", "nullable" : true }, "currency" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "lookupKey" : { "type" : "string", "nullable" : true }, "nickname" : { "type" : "string", "nullable" : true }, "productId" : { "type" : "string", "nullable" : true }, "productNameId" : { "type" : "string", "nullable" : true }, "recurringInterval" : { "type" : "string", "nullable" : true }, "recurringIntervalCount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "recurringUsageType" : { "type" : "string", "nullable" : true }, "taxBehavior" : { "type" : "string", "nullable" : true }, "transformQuantity" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "nullable" : true }, "unitAmount" : { "type" : "number", "nullable" : true }, "unitAmountDecimal" : { "type" : "string", "nullable" : true } } }, "Billing_GetProductsWSResponse_Product" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "nullable" : true }, "created" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultPriceId" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "nameId" : { "type" : "string", "nullable" : true }, "prices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Price" }, "nullable" : true }, "statementDescriptor" : { "type" : "string", "nullable" : true } } }, "Billing_GetSubscriptionWSRequest" : { "type" : "object" }, "Billing_GetSubscriptionWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "subscriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_GetSubscriptionWSResponse_Subscription" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_GetSubscriptionWSResponse_Subscription" : { "type" : "object", "properties" : { "cancelAtPeriodEnd" : { "type" : "boolean", "nullable" : true }, "canceledAt" : { "type" : "integer", "format" : "int64", "nullable" : true }, "collectionMethod" : { "type" : "string", "nullable" : true }, "created" : { "type" : "integer", "format" : "int64", "nullable" : true }, "currency" : { "type" : "string", "nullable" : true }, "currentPeriodEnd" : { "type" : "integer", "format" : "int64", "nullable" : true }, "currentPeriodStart" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultPaymentMethod" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "isApproachingLimit" : { "type" : "boolean", "nullable" : true }, "maxSpendPerMonth" : { "type" : "integer", "format" : "int64", "nullable" : true }, "pricePerUnit" : { "type" : "string", "nullable" : true }, "product" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "trialEnd" : { "type" : "integer", "format" : "int64", "nullable" : true }, "upcomingInvoiceAmount" : { "type" : "string", "nullable" : true }, "upcomingInvoiceCurrency" : { "type" : "string", "nullable" : true }, "usageType" : { "type" : "string", "nullable" : true } } }, "Billing_HistoricalUsageWSRequest" : { "type" : "object", "properties" : { "products" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "range" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "Billing_HistoricalUsageWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "usage" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Billing_HistoricalUsageWSResponse_HistoricalUsageElement" }, "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_HistoricalUsageWSResponse_HistoricalUsageElement" : { "type" : "object", "properties" : { "costInCent" : { "type" : "integer", "format" : "int64", "nullable" : true }, "date" : { "type" : "string", "nullable" : true }, "eventCount" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Billing_InvoiceStatus" : { "type" : "string", "enum" : [ "DRAFT", "OPEN", "PAID", "UNCOLLECTIBLE", "VOID", "ALL" ] }, "Billing_SetDefaultPaymentMethodForSubscriptionWSRequest" : { "type" : "object", "properties" : { "paymentMethodId" : { "type" : "string", "nullable" : true }, "subscriptionId" : { "type" : "string", "nullable" : true } } }, "Billing_SetDefaultPaymentMethodForSubscriptionWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_SetDefaultPaymentMethodWSRequest" : { "type" : "object", "properties" : { "overrideAllSubscriptionPaymentMethods" : { "type" : "boolean", "nullable" : true }, "paymentMethodId" : { "type" : "string", "nullable" : true } } }, "Billing_SetDefaultPaymentMethodWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_SetupSubscriptionWSRequest" : { "type" : "object", "properties" : { "termsOfServiceAccepted" : { "type" : "boolean", "nullable" : true } } }, "Billing_SetupSubscriptionWSResponse" : { "type" : "object", "properties" : { "clientSecret" : { "type" : "string", "nullable" : true }, "customerId" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_UnsubscribeWSRequest" : { "type" : "object", "properties" : { "subscriptionId" : { "type" : "string", "nullable" : true } } }, "Billing_UnsubscribeWSResponse" : { "type" : "object", "properties" : { "cancelAtPeriodEnd" : { "type" : "boolean", "nullable" : true }, "canceledAt" : { "type" : "integer", "format" : "int64", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "subscriptionId" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_UpdateCustomerInformationWSRequest" : { "type" : "object", "properties" : { "addressCity" : { "type" : "string", "nullable" : true }, "addressCountry" : { "type" : "string", "nullable" : true }, "addressLine1" : { "type" : "string", "nullable" : true }, "addressLine2" : { "type" : "string", "nullable" : true }, "addressPostalCode" : { "type" : "string", "nullable" : true }, "addressState" : { "type" : "string", "nullable" : true }, "businessName" : { "type" : "string", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "individualName" : { "type" : "string", "nullable" : true }, "phone" : { "type" : "string", "nullable" : true }, "termsOfServiceAccepted" : { "type" : "boolean", "nullable" : true } } }, "Billing_UpdateCustomerInformationWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Billing_UpdateSubscriptionMaxSpendWSRequest" : { "type" : "object", "properties" : { "maxSpendPerMonth" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subscriptionId" : { "type" : "string", "nullable" : true } } }, "Billing_UpdateSubscriptionMaxSpendWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "maxSpendPerMonth" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subscriptionId" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "BinaryAggregationValue" : { "type" : "object", "description" : "Map of binary count reports", "properties" : { "eventCount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "false" : { "type" : "integer", "format" : "int64", "nullable" : true }, "localDate" : { "type" : "string", "nullable" : true }, "maxValueTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "minValueTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "true" : { "type" : "integer", "format" : "int64", "nullable" : true }, "utcDate" : { "type" : "string", "nullable" : true } } }, "Ble_BleDeviceMap" : { "type" : "object", "description" : "Map of BLE device keys to their advertisement data.", "properties" : { "keyToSecureBeacon" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of device keys to secure beacon advertisement data", "items" : { "type" : "string", "format" : "byte", "description" : "Map of device keys to secure beacon advertisement data", "nullable" : true }, "nullable" : true }, "description" : "Map of device keys to secure beacon advertisement data", "nullable" : true } } }, "Ble_BleRegisteredDeviceWSType" : { "type" : "object", "description" : "Information about a registered BLE device.", "properties" : { "deleted" : { "type" : "boolean", "description" : "Indicates if the device has been deleted", "example" : false, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "name" : { "type" : "string", "description" : "Name of the registered BLE device", "example" : "Temperature Sensor 1", "nullable" : true }, "secret" : { "type" : "array", "description" : "Secret data for the registered BLE device", "items" : { "type" : "string", "format" : "byte", "description" : "Secret data for the registered BLE device", "nullable" : true }, "nullable" : true }, "updateToFirmwareVersion" : { "type" : "string", "description" : "Firmware version to update to", "example" : "2.1.0", "nullable" : true } } }, "Ble_BleUnregisteredHardwareWSType" : { "type" : "object", "description" : "Information about an unregistered BLE hardware device.", "properties" : { "mac" : { "type" : "string", "description" : "MAC address of the unregistered BLE device", "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, "secret" : { "type" : "array", "description" : "Secret data for the unregistered BLE device", "items" : { "type" : "string", "format" : "byte", "description" : "Secret data for the unregistered BLE device", "nullable" : true }, "nullable" : true } } }, "Ble_GetBaseStationsWSRequest" : { "type" : "object", "description" : "Request to get available base stations for BLE sensors." }, "Ble_GetBaseStationsWSResponse" : { "type" : "object", "description" : "Response containing available base stations for BLE sensors.", "properties" : { "baseStations" : { "type" : "array", "description" : "List of base station UUIDs available for BLE sensors", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Ble_GetSecureSecretForRegisteredWSResponse" : { "type" : "object", "description" : "Response containing secure secrets for registered BLE devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "hardwareVariationToFirmwareDownloadUrl" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, "keyToRegisteredDevice" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Ble_BleRegisteredDeviceWSType" }, "description" : "Map of device keys to registered device information", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Ble_GetSecureSecretForUnregisteredWSResponse" : { "type" : "object", "description" : "Response containing secure secrets for unregistered BLE devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "keyToUnregisteredDevice" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Ble_BleUnregisteredHardwareWSType" }, "description" : "Map of serial numbers to unregistered device information", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Ble_GetSensorHardwareFirmwareUpdateDetailsRequest" : { "type" : "object", "description" : "Request to get firmware update details for BLE sensors." }, "Ble_GetSensorHardwareFirmwareUpdateDetailsResponse" : { "type" : "object", "description" : "Response containing firmware update details for BLE sensors.", "properties" : { "hardwareVariationToFirmwareDownloadUrl" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, "description" : "Map of hardware variations to firmware download URLs", "nullable" : true } } }, "Ble_RegisterSensorWSRequest" : { "type" : "object", "description" : "Request to register a BLE sensor device.", "properties" : { "bleData" : { "type" : "array", "description" : "BLE advertisement data from the sensor", "items" : { "type" : "string", "format" : "byte", "description" : "BLE advertisement data from the sensor", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate for sensor placement", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate for sensor placement", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the sensor device", "example" : "Temperature Sensor 1", "nullable" : true }, "serialNum" : { "type" : "string", "description" : "Serial number of the BLE sensor", "example" : "SN123456789", "nullable" : true } } }, "Ble_RegisterSensorWSResponse" : { "type" : "object", "description" : "Response from registering a BLE sensor.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Ble_UnregisterSensorWSRequest" : { "type" : "object", "description" : "Request to unregister a BLE sensor.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Ble_UnregisterSensorWSResponse" : { "type" : "object", "description" : "Response from unregistering a BLE sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failureReason" : { "type" : "string", "description" : "Reason for failure if unregistration was not successful", "example" : "Device not found", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Indicates if the unregistration was successful", "example" : true, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "BoardPhysicalPortConfigType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "portMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PhysicalPortType" }, "nullable" : true } } }, "BodyPart" : { "type" : "object", "nullable" : true, "properties" : { "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "entity" : { "type" : "object", "nullable" : true }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "parameterizedHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "providers" : { "$ref" : "#/components/schemas/Providers" } } }, "BoulevardType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "accessWindowAfterMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "accessWindowBeforeMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "boulevardBusinessId" : { "type" : "string", "nullable" : true }, "boulevardLocationToRhombusLocationMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Boulevard_BoulevardUnlockRequest" : { "type" : "object", "description" : "Request object for unlocking a door via Boulevard.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sessionToken" : { "type" : "string", "description" : "Boulevard session token", "nullable" : true } } }, "Boulevard_BoulevardUnlockResponse" : { "type" : "object", "description" : "Response object for a Boulevard unlock request.", "properties" : { "doorName" : { "type" : "string", "description" : "Name of the door that was unlocked", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMessage" : { "type" : "string", "description" : "Error message if unlock failed", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Whether the unlock was successful", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "BoxSettings" : { "type" : "object", "description" : "Box file storage integration settings to update", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "enterpriseId" : { "type" : "string", "nullable" : true }, "folderId" : { "type" : "string", "nullable" : true } } }, "BrivoSettings" : { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "nullable" : true }, "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "clientId" : { "type" : "string", "nullable" : true }, "clientSecret" : { "type" : "string", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorToCameraMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true, "writeOnly" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "username" : { "type" : "string", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "BrivoType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "nullable" : true }, "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiKey" : { "type" : "string", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "clientId" : { "type" : "string", "nullable" : true }, "clientSecret" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "username" : { "type" : "string", "nullable" : true }, "version" : { "type" : "integer", "format" : "int32", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "BurstyRateLimit" : { "type" : "object", "properties" : { "base_interval_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "burst_token_generation_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "burst_token_initial_count" : { "type" : "integer", "format" : "int32", "nullable" : true }, "burst_token_max_count" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "ButterflyMXSettings" : { "type" : "object", "properties" : { "buildingWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "A HashMap of . ", "nullable" : true }, "description" : "A HashMap of . ", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "panelInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ButterflymxPanelInfoType" }, "description" : "A HashMap of .", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "ButterflyMXType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "buildingWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "A HashMap of . ", "nullable" : true }, "description" : "A HashMap of . ", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "panelInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ButterflymxPanelInfoType" }, "description" : "A HashMap of .", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ButterflymxBuilding" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "panels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorType" }, "nullable" : true } } }, "ButterflymxPanelInfoType" : { "type" : "object", "description" : "A HashMap of .", "nullable" : true, "properties" : { "assignedCameraList" : { "type" : "array", "description" : "The list of Rhombus Camera RUUIDs.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "buildingId" : { "type" : "integer", "format" : "int32", "description" : "The ButterflyMx Building Id.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "panelName" : { "type" : "string", "description" : "The ButterflyMx Panel Name.", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "ButtonEnumType" : { "type" : "string", "enum" : [ "integrated_generic_button", "integrated_doorbell_button", "schlage_rs485_input_button", "aperio_rs485_activator_button" ] }, "ButtonEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "buttonPress" : { "$ref" : "#/components/schemas/ButtonPressEnum" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newSupervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" }, "pressDurationMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ButtonIntegrationRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "thirdPartyBatteryLevel" : { "type" : "string", "nullable" : true }, "thirdPartyButtonAction" : { "type" : "string", "nullable" : true }, "thirdPartyButtonName" : { "type" : "string", "nullable" : true }, "thirdPartyButtonSerialNumber" : { "type" : "string", "nullable" : true }, "thirdPartyButtonUuid" : { "type" : "string", "nullable" : true }, "timestamp" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "ButtonModeEnum" : { "type" : "string", "description" : "Optional button mode configuration", "enum" : [ "PANIC", "PROGRAMMABLE", "DOORBELL", "NONE" ] }, "ButtonPhysicalPortEnumType" : { "type" : "string", "enum" : [ "GPIO_INPUT", "BUTTON_INPUT" ] }, "ButtonPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/ButtonPhysicalPortEnumType" } } }, "ButtonPressEnum" : { "type" : "string", "enum" : [ "NONE", "SINGLE", "DOUBLE", "LONG", "INITIAL_PRESS", "LONG_RELEASE" ] }, "ButtonSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Button settings", "properties" : { "button_emergency_onsite_contact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "button_test_mode_enabled" : { "type" : "boolean", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "Button_ButtonHealthDetailsEnum" : { "type" : "string", "description" : "Detailed health status for button sensors.", "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] }, "Button_ButtonHealthEnum" : { "type" : "string", "description" : "Health status for button sensors.", "enum" : [ "GREEN", "RED" ] }, "Button_CreateRuleForButtonWSRequest" : { "type" : "object", "description" : "Request to create a rule for a button sensor.", "properties" : { "rule" : { "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" } } }, "Button_CreateRuleForButtonWSResponse" : { "type" : "object", "description" : "Response from creating a rule for a button sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_DeleteRuleForButtonWSRequest" : { "type" : "object", "description" : "Request to delete a rule for a button sensor.", "properties" : { "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Button_DeleteRuleForButtonWSResponse" : { "type" : "object", "description" : "Response from deleting a rule for a button sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_ExternalButtonRuleType" : { "type" : "object", "description" : "External button rule configuration.", "properties" : { "action" : { "$ref" : "#/components/schemas/RuleActionType" }, "ruleFilters" : { "$ref" : "#/components/schemas/RuleFilterType" }, "ruleName" : { "type" : "string", "description" : "Name of the button rule", "example" : "Emergency Alert Rule", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "triggerPress" : { "$ref" : "#/components/schemas/ButtonPressEnum" } } }, "Button_GetButtonPressEventsForSensorWSRequest" : { "type" : "object", "description" : "Request to get button press events for a specific sensor.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds to get events created after this time", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds to get events created before this time", "example" : 1640995200000, "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of events to return", "example" : 100, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Button_GetButtonPressEventsForSensorWSResponse" : { "type" : "object", "description" : "Response containing button press events for a sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "events" : { "type" : "array", "description" : "List of button press events for the sensor", "items" : { "$ref" : "#/components/schemas/ButtonEventType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_GetButtonRulesForOrgWSRequest" : { "type" : "object", "description" : "Request to get rules for all buttons in an organization." }, "Button_GetButtonRulesForOrgWSResponse" : { "type" : "object", "description" : "Response containing rules for all buttons in an organization.", "properties" : { "buttonUuidToRulesMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of button UUIDs to their associated rules", "items" : { "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" }, "nullable" : true }, "description" : "Map of button UUIDs to their associated rules", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_GetMinimalButtonStatesWSRequest" : { "type" : "object", "description" : "Request to get minimal state information for all button sensors." }, "Button_GetMinimalButtonStatesWSResponse" : { "type" : "object", "description" : "Response containing minimal state information for all button sensors.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "states" : { "type" : "array", "description" : "List of minimal button state information", "items" : { "$ref" : "#/components/schemas/Button_MinimalButtonStateType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_GetRulesForButtonWSRequest" : { "type" : "object", "description" : "Request to get rules for a button sensor.", "properties" : { "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Button_GetRulesForButtonWSResponse" : { "type" : "object", "description" : "Response containing rules for a button sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of rules configured for the button sensor", "items" : { "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Button_MinimalButtonStateType" : { "type" : "object", "description" : "Minimal state information for a button sensor.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "batteryPercent" : { "type" : "integer", "format" : "int32", "description" : "Battery percentage of the button sensor", "example" : 85, "nullable" : true }, "buttonEmergencyOnsiteContact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "buttonMode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "closestBaseStation" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Creation timestamp in milliseconds", "example" : 1640995200000, "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version of the button sensor", "example" : "2.1.0", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the button sensor is located", "example" : 1, "nullable" : true }, "health" : { "$ref" : "#/components/schemas/Button_ButtonHealthEnum" }, "healthDetails" : { "$ref" : "#/components/schemas/Button_ButtonHealthDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lastSeenSec" : { "type" : "integer", "format" : "int64", "description" : "Last time the button sensor was seen in seconds", "example" : 1640995200, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the button sensor", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the button sensor", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the button sensor", "example" : "Main Entrance Button", "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the button sensor", "example" : "SN123456789", "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the button sensor", "example" : -45, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "testModeEnabled" : { "type" : "boolean", "description" : "Indicates if test mode is enabled for the button sensor", "example" : false, "nullable" : true } } }, "Button_UpdateButtonConfigWSRequest" : { "type" : "object", "description" : "Request to update button sensor configuration.", "properties" : { "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableButtonUserConfig" } } }, "Button_UpdateButtonDetailsWSRequest" : { "type" : "object", "description" : "Request to update button sensor details.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "buttonMode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "description" : { "type" : "string", "description" : "Optional description for the button sensor", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Optional floor number", "example" : 1, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Optional latitude coordinate", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Optional longitude coordinate", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Optional name for the button sensor", "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true } } }, "Buyer" : { "type" : "object", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "address3" : { "type" : "string", "nullable" : true }, "city" : { "type" : "string", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "contactName" : { "type" : "string", "nullable" : true }, "country" : { "type" : "string", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "state" : { "type" : "string", "nullable" : true } } }, "COSensorType" : { "type" : "object", "properties" : { "adcRaw" : { "type" : "integer", "format" : "int32", "nullable" : true }, "adcVoltage" : { "type" : "number", "format" : "double", "nullable" : true }, "coConcentration" : { "type" : "number", "format" : "double", "nullable" : true }, "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "CameraAiDewarpConfigType" : { "type" : "object", "properties" : { "dewarp_tile_height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "dewarp_tile_width" : { "type" : "integer", "format" : "int32", "nullable" : true }, "orientation" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CameraConfiguration" : { "type" : "object", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "checkConditionOverride" : { "$ref" : "#/components/schemas/CheckCondition" }, "exampleImages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExampleImage" }, "nullable" : true }, "promptExtension" : { "type" : "string", "nullable" : true }, "promptOverride" : { "type" : "string", "nullable" : true }, "region" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "scheduledActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScheduledAction" }, "nullable" : true } } }, "CameraCrossCountingSettingsType" : { "type" : "object", "properties" : { "directions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CrossingDirectionEnum" }, "nullable" : true, "uniqueItems" : true }, "in_roi" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, "object_type" : { "$ref" : "#/components/schemas/CrossingObjectEnum" }, "object_type_id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "out_roi" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true } } }, "CameraDewarpModeEnum" : { "type" : "string", "enum" : [ "NO_TRANSFORM", "NORMAL", "PANORAMA", "SUB_REGION", "VERTICAL_PANORAMA", "TRANSVERSE_MERCATOR", "MERCATOR", "EQUIRECTANGULAR" ] }, "CameraHumanLoiteringSettingsType" : { "type" : "object", "properties" : { "roi" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true } } }, "CameraInactivitySettingsType" : { "type" : "object", "properties" : { "object_type" : { "$ref" : "#/components/schemas/InactivityObjectTypeEnum" }, "roi" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "threshold_ms" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "CameraMeteringConfigType" : { "type" : "object", "properties" : { "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "table" : { "type" : "string", "nullable" : true } } }, "CameraMotorConfigType" : { "type" : "object", "properties" : { "af_enabled" : { "type" : "boolean", "nullable" : true }, "af_region" : { "$ref" : "#/components/schemas/PermyriadRect" }, "focus" : { "type" : "integer", "format" : "int32", "nullable" : true }, "pan_degrees" : { "type" : "number", "format" : "float", "nullable" : true }, "piris" : { "type" : "integer", "format" : "int32", "nullable" : true }, "pt_speed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tilt_degrees" : { "type" : "number", "format" : "float", "nullable" : true }, "zoom" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CameraMountingDirectionEnum" : { "type" : "string", "enum" : [ "DOWN", "UP", "SIDEWAYS", "UNKNOWN" ] }, "CameraPTZConfigType" : { "type" : "object", "properties" : { "offset_x_percent" : { "type" : "number", "format" : "float", "nullable" : true }, "offset_y_percent" : { "type" : "number", "format" : "float", "nullable" : true }, "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "size_percent" : { "type" : "number", "format" : "float", "nullable" : true } } }, "CameraPTZEngineEnum" : { "type" : "string", "enum" : [ "DIGITAL", "MECHANICAL", "NONE", "UNKNOWN" ] }, "CameraPTZMovementEnum" : { "type" : "string", "enum" : [ "RELATIVE", "ABSOLUTE" ] }, "CameraPTZTranslationSpaceEnum" : { "type" : "string", "enum" : [ "FOV", "DIGITAL", "NONE", "UNKNOWN" ] }, "CameraPolicyV2Type" : { "type" : "object", "description" : "List of camera policies using the schedule", "properties" : { "defaultTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CameraTriggerType" }, "nullable" : true, "uniqueItems" : true }, "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CameraScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "CameraPosition" : { "type" : "object", "properties" : { "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true } } }, "CameraPtzHome" : { "type" : "object", "properties" : { "go_home_seq" : { "type" : "integer", "format" : "int64", "nullable" : true }, "pan_degrees" : { "type" : "number", "format" : "float", "nullable" : true }, "tilt_degrees" : { "type" : "number", "format" : "float", "nullable" : true }, "zoom" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CameraScheduledTriggerType" : { "type" : "object", "properties" : { "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CameraTriggerType" }, "nullable" : true, "uniqueItems" : true } } }, "CameraTriggerType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "customDetectionUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "dwellTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dwellTimeResetMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "faceAlertLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "faceAlertUnidentified" : { "type" : "boolean", "nullable" : true }, "faceAllowedLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "vehicleAlertLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "vehicleAlertUnidentified" : { "type" : "boolean", "nullable" : true }, "vehicleAllowedLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "CameraType" : { "type" : "object", "description" : "List of third-party cameras assigned to the specified NVR", "properties" : { "archiveRegion" : { "type" : "string", "nullable" : true }, "cameraFramerate" : { "type" : "integer", "format" : "int32", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "customData" : { "type" : "string", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "deviceFacetRadians" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hardwareId" : { "type" : "string", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaRegionHistory" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" }, "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mediaStorageDeviceUuidByFacet" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pending" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "unregisteredEmailSent" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "CameraVisualTamperConfigType" : { "type" : "object", "properties" : { "analyze_fps" : { "type" : "integer", "format" : "int32", "nullable" : true }, "analyze_res" : { "type" : "integer", "format" : "int32", "nullable" : true }, "canny_thresh" : { "type" : "number", "format" : "float", "nullable" : true }, "edge_cov_diff_thresh" : { "type" : "number", "format" : "float", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "long_buf_size" : { "type" : "integer", "format" : "int32", "nullable" : true }, "short_buf_size" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Camera_CameraBackwardsCompatUpdateType" : { "type" : "object", "description" : "Backwards compatible camera update type with optional fields.", "properties" : { "archiveRegion" : { "type" : "string", "description" : "Archive region for the camera", "example" : "us-west-1", "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the camera is deleted", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the camera", "example" : "Camera monitoring the main entrance", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the camera is located", "example" : 1, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the camera", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the camera", "example" : -122.4194, "nullable" : true }, "mummified" : { "type" : "boolean", "description" : "Whether the camera is mummified", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the camera", "example" : "Front Door Camera", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_CameraCurrentStateType" : { "type" : "object", "description" : "Current state information for a camera.", "properties" : { "baseVideoOperationUri" : { "type" : "string", "description" : "Base URI for video operations", "example" : "https://api.example.com/video", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/Camera_StatusEnum" }, "connectionTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Connection timestamp in milliseconds", "example" : 1640995200000, "nullable" : true }, "defaultInterface" : { "type" : "string", "description" : "Default network interface", "example" : "eth0", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "description" : "MAC address of default interface", "example" : "00:11:22:33:44:55", "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Current firmware version", "example" : "1.2.3", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/Camera_StatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" }, "latestFirmwareVersion" : { "type" : "string", "description" : "Latest available firmware version", "example" : "1.2.4", "nullable" : true }, "mediaRegion" : { "type" : "string", "description" : "Media region", "example" : "us-west-1", "nullable" : true }, "onCameraState" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "State information stored on the camera", "nullable" : true }, "description" : "State information stored on the camera", "nullable" : true }, "onCloudState" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "State information stored in the cloud", "nullable" : true }, "description" : "State information stored in the cloud", "nullable" : true }, "region" : { "type" : "string", "description" : "Camera region", "example" : "us-west-1", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Camera serial number", "example" : "CAM123456789", "nullable" : true }, "ssid" : { "type" : "string", "description" : "WiFi SSID", "example" : "MyNetwork", "nullable" : true }, "versionsBehind" : { "type" : "integer", "format" : "int32", "description" : "Number of firmware versions behind", "example" : 1, "nullable" : true }, "wifiApMac" : { "type" : "string", "description" : "MAC address of WiFi access point", "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "description" : "WiFi signal strength in bars (1-5)", "example" : 4, "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "description" : "WiFi signal strength in dBm", "example" : -45, "nullable" : true } } }, "Camera_CameraExternalFacetedType" : { "type" : "object", "description" : "External faceted camera type with device UUID.", "properties" : { "archiveRegion" : { "type" : "string", "nullable" : true }, "cameraFramerate" : { "type" : "integer", "format" : "int32", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "customData" : { "type" : "string", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "deviceFacetRadians" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaRegionHistory" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" }, "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mediaStorageDeviceUuidByFacet" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "pending" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "unregisteredEmailSent" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_CameraExternalType" : { "type" : "object", "description" : "External camera type.", "properties" : { "archiveRegion" : { "type" : "string", "nullable" : true }, "cameraFramerate" : { "type" : "integer", "format" : "int32", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "customData" : { "type" : "string", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "deviceFacetRadians" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaRegionHistory" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" }, "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mediaStorageDeviceUuidByFacet" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "pending" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "unregisteredEmailSent" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_CameraOfflineLanStreamingInfo" : { "type" : "object", "description" : "Information for offline LAN streaming.", "properties" : { "accessToken" : { "type" : "string", "description" : "Access token for LAN streaming", "example" : "abc123def456", "nullable" : true }, "lanAddresses" : { "type" : "array", "description" : "List of LAN addresses for streaming", "items" : { "type" : "string", "description" : "List of LAN addresses for streaming", "nullable" : true }, "nullable" : true } } }, "Camera_CameraPTZMoveWSRequest" : { "type" : "object", "description" : "Request object for moving a Rhombus first-party mechanical PTZ camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "xmovementPermyriad" : { "type" : "integer", "format" : "int32", "description" : "X-axis movement in permyriad units", "example" : 1000, "nullable" : true }, "ymovementPermyriad" : { "type" : "integer", "format" : "int32", "description" : "Y-axis movement in permyriad units", "example" : 1000, "nullable" : true }, "zmovementPermyriad" : { "type" : "integer", "format" : "int32", "description" : "Z-axis movement in permyriad units", "example" : 1000, "nullable" : true } } }, "Camera_CameraPTZMoveWSResponse" : { "type" : "object", "description" : "Response object for moving a Rhombus first-party mechanical PTZ camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_CreateCustomFootageSeekpointsWSRequest" : { "type" : "object", "description" : "Request to create custom footage seek points for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "footageSeekPoints" : { "type" : "array", "description" : "List of custom footage seek points to create", "items" : { "$ref" : "#/components/schemas/CustomFootageSeekPointType" }, "nullable" : true } } }, "Camera_CreateFootageBoundingBoxesWSRequest" : { "type" : "object", "description" : "Request to create footage bounding boxes for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "footageBoundingBoxes" : { "type" : "array", "description" : "List of footage bounding boxes to create", "items" : { "$ref" : "#/components/schemas/FootageBoundingBoxType" }, "nullable" : true } } }, "Camera_CreateFootageBoundingBoxesWSResponse" : { "type" : "object", "description" : "Response indicating the result of creating footage bounding boxes.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_CreateFootageSeekpointsWSResponse" : { "type" : "object", "description" : "Response indicating the result of creating footage seek points.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_CreateSharedLiveVideoStreamWSRequest" : { "type" : "object", "description" : "Request to create a shared live video stream for a camera.", "properties" : { "audioGatewayUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "expirationTimeSecs" : { "type" : "integer", "format" : "int32", "description" : "Add an expiration date for accessing the stream in seconds", "example" : 86400, "nullable" : true }, "includeAudio" : { "type" : "boolean", "description" : "Camera must be associated with an audio gateway to have audio", "example" : false, "nullable" : true }, "invertSchedule" : { "type" : "boolean", "description" : "If given a schedule UUID, will hide the stream during the schedule instead and show it otherwise", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "If not provided, will be named 'Unnamed'", "example" : "Front Door Live Stream", "nullable" : true }, "password" : { "type" : "string", "description" : "Add a password to allow access to your shared stream", "example" : "mypassword123", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ssoProtected" : { "type" : "boolean", "description" : "Org must have SSO setup to use SSO protected streams", "example" : false, "nullable" : true }, "streamType" : { "$ref" : "#/components/schemas/StreamTypeEnum" }, "vodEnabled" : { "type" : "boolean", "description" : "Enables recording of live footage to a VOD", "example" : true, "nullable" : true } } }, "Camera_CreateSharedLiveVideoStreamWSResponse" : { "type" : "object", "description" : "Response containing the created shared live video stream information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveM3U8StreamUrl" : { "type" : "string", "description" : "M3U8 URL for the shared live video stream", "example" : "https://example.com/live/m3u8/stream", "nullable" : true }, "sharedLiveVideoStreamUrl" : { "type" : "string", "description" : "URL for the shared live video stream", "example" : "https://example.com/live/video/stream", "nullable" : true }, "sharedLiveVideoStreamUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_CreateSharedVideoWallWSRequest" : { "type" : "object", "description" : "Request to create a shared video wall.", "properties" : { "expirationTimeSecs" : { "type" : "integer", "format" : "int32", "description" : "Expiration time in seconds", "example" : 86400, "nullable" : true }, "invertSchedule" : { "type" : "boolean", "description" : "Whether to invert the schedule", "example" : false, "nullable" : true }, "password" : { "type" : "string", "description" : "Password to protect the shared video wall", "example" : "mypassword123", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "vodEnabled" : { "type" : "boolean", "description" : "Whether to enable video on demand", "example" : true, "nullable" : true } } }, "Camera_CreateSharedVideoWallWSResponse" : { "type" : "object", "description" : "Response containing the created shared video wall information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveVideoStreamUrl" : { "type" : "string", "description" : "URL for accessing the shared video wall", "example" : "https://share.rhombussystems.com/videowall/abc123", "nullable" : true }, "sharedLiveVideoStreamUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_CreateVideoWallWSRequest" : { "type" : "object", "description" : "Request to create a video wall.", "properties" : { "videoWall" : { "$ref" : "#/components/schemas/VideoWallType" } } }, "Camera_CreateVideoWallWSResponse" : { "type" : "object", "description" : "Response from creating a video wall.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_DeleteCameraWSRequest" : { "type" : "object", "description" : "Request to delete a camera from the system.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Whether to mummify the camera instead of permanent deletion", "example" : false, "nullable" : true } } }, "Camera_DeleteCameraWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_DeleteCustomFootageSeekpointsWSRequest" : { "type" : "object", "description" : "Request to delete custom footage seek points for cameras within a time range.", "properties" : { "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to delete custom seek points for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "customName" : { "type" : "string", "description" : "Filter which custom seek points to delete with the custom name provided", "example" : "motion_event", "nullable" : true }, "endTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "UNIX milliseconds timestamp to end custom seek point deletion, up to 24 hours from the start timestamp", "example" : 1641081600000, "nullable" : true }, "startTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "UNIX milliseconds timestamp to start custom seek point deletion", "example" : 1640995200000, "nullable" : true } } }, "Camera_DeleteCustomFootageSeekpointsWSResponse" : { "type" : "object", "description" : "Response containing the results of deleting custom footage seek points.", "properties" : { "deleteSeekpointResponseMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" }, "description" : "Mapping of camera UUIDs to seek point deletion results", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" : { "type" : "object", "description" : "Response indicating the result of deleting seek points for a camera.", "properties" : { "err" : { "type" : "boolean", "description" : "Whether an error occurred during deletion", "example" : false, "nullable" : true }, "errMsg" : { "type" : "string", "description" : "Error message if deletion failed", "example" : "Invalid timestamp range", "nullable" : true } } }, "Camera_DeleteSharedLiveVideoStreamWSRequest" : { "type" : "object", "description" : "Request to delete a shared live video stream.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_DeleteSharedVideoWallWSRequest" : { "type" : "object", "description" : "Request to delete a shared video wall.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_DeleteSharedVideoWallWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting a shared video wall.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_DeleteVideoWallWSRequest" : { "type" : "object", "description" : "Request to delete a video wall configuration.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_DeleteVideoWallWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting a video wall configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_EraseCameraWSRequest" : { "type" : "object", "description" : "Request to permanently erase a camera from the system.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_EraseCameraWSResponse" : { "type" : "object", "description" : "Response indicating the result of erasing a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_FindAllSharedLiveVideoStreamsWSRequest" : { "type" : "object", "description" : "Request to find all shared live video streams." }, "Camera_FindAllSharedLiveVideoStreamsWSResponse" : { "type" : "object", "description" : "Response containing all shared live video streams.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveVideoStreams" : { "type" : "array", "description" : "List of shared live video streams", "items" : { "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_FindSharedLiveVideoStreamsForWSRequest" : { "type" : "object", "description" : "Request to find shared live video streams for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Camera_FindSharedLiveVideoStreamsWSResponse" : { "type" : "object", "description" : "Response containing shared live video streams.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveVideoStreams" : { "type" : "array", "description" : "List of shared live video streams", "items" : { "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_FindSharedVideoWallsWSRequest" : { "type" : "object", "description" : "Request to find shared video walls for a video wall.", "properties" : { "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_FindSharedVideoWallsWSResponse" : { "type" : "object", "description" : "Response containing shared video walls for a video wall.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedVideoWalls" : { "type" : "array", "description" : "List of shared video walls", "items" : { "$ref" : "#/components/schemas/Camera_SharedVideoWallWS" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_FootageBoundingBoxSummaryType" : { "type" : "object", "description" : "Summary of footage bounding boxes by device.", "properties" : { "deviceMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/FootageBoundingBoxType" }, "description" : "Map of device UUIDs to their footage bounding box information", "nullable" : true } } }, "Camera_FootageSeekPointSummaryType" : { "type" : "object", "description" : "Summary of footage seek points with activity counts and metadata.", "properties" : { "activityCountMap" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, "alert" : { "type" : "boolean", "description" : "Whether there is an alert", "example" : false, "nullable" : true }, "faceNames" : { "type" : "array", "description" : "Set of recognized face names", "items" : { "type" : "string", "description" : "Set of recognized face names", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "poses" : { "type" : "array", "description" : "Set of detected poses", "items" : { "type" : "string", "description" : "Set of detected poses", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "recognizedObjects" : { "type" : "array", "description" : "Set of recognized objects", "items" : { "type" : "string", "description" : "Set of recognized objects", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unidentifiedFaceIds" : { "type" : "array", "description" : "Set of unidentified face IDs", "items" : { "type" : "string", "description" : "Set of unidentified face IDs", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "vehicleLicensePlates" : { "type" : "array", "description" : "Set of vehicle license plates", "items" : { "type" : "string", "description" : "Set of vehicle license plates", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "vehicleNames" : { "type" : "array", "description" : "Set of recognized vehicle names", "items" : { "type" : "string", "description" : "Set of recognized vehicle names", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Camera_GenerateBatchRegistrationInfoRequest" : { "type" : "object", "description" : "Request to generate batch registration information for cameras.", "properties" : { "adminUserPermissionGroups" : { "type" : "array", "description" : "List of admin user permission group UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate", "example" : -122.4194, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "readOnlyUserPermissionGroups" : { "type" : "array", "description" : "List of read-only user permission group UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Camera_GenerateBatchRegistrationInfoResponse" : { "type" : "object", "description" : "Response containing batch registration information for cameras.", "properties" : { "env" : { "type" : "string", "description" : "Environment identifier", "example" : "production", "nullable" : true }, "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GenerateWifiChangeAuthorizationTokenWSRequest" : { "type" : "object", "description" : "Request to generate a WiFi change authorization token.", "properties" : { "perceivedIp" : { "type" : "string", "description" : "Perceived IP address", "example" : "192.168.1.100", "nullable" : true }, "ssid" : { "type" : "string", "description" : "WiFi network SSID", "example" : "MyWiFiNetwork", "nullable" : true } } }, "Camera_GenerateWifiChangeAuthorizationTokenWSResponse" : { "type" : "object", "description" : "Response containing a WiFi change authorization token.", "properties" : { "authorizationToken" : { "type" : "array", "description" : "Authorization token for WiFi change", "items" : { "type" : "string", "format" : "byte", "description" : "Authorization token for WiFi change", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetBatchRegistrationTokenUsageRequest" : { "type" : "object", "description" : "Request to retrieve batch registration token usage information.", "properties" : { "sinceMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds since epoch to check usage from", "example" : 1640995200000, "nullable" : true }, "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GetBatchRegistrationTokenUsageResponse" : { "type" : "object", "description" : "Response containing batch registration token usage information.", "properties" : { "usageList" : { "type" : "array", "description" : "List of batch registration token usage results", "items" : { "$ref" : "#/components/schemas/BatchRegistrationTokenUsageResult" }, "nullable" : true } } }, "Camera_GetCameraAIThresholdsWSRequest" : { "type" : "object", "description" : "Request to retrieve AI thresholds for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Camera_GetCameraAIThresholdsWSResponse" : { "type" : "object", "description" : "Response containing AI thresholds for a camera.", "properties" : { "consecutiveHumanFilter" : { "type" : "integer", "format" : "int32", "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", "example" : 3, "nullable" : true }, "consecutiveVehicleFilter" : { "type" : "integer", "format" : "int32", "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", "example" : 3, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "faceConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for face detection. 0 or null means the built-in default.", "example" : 0.8, "nullable" : true }, "faceMatchConfidenceThreshold" : { "type" : "number", "format" : "float", "deprecated" : true, "description" : "Confidence threshold for face matching (determining if two faces are the same person). 0 or null means the built-in default. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", "maximum" : 1.0, "minimum" : 0.0, "nullable" : true }, "humanConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for human detection. 0 or null means the built-in default.", "example" : 0.7, "nullable" : true }, "lprConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for license plate detection and character recognition. 0 or null means the built-in default.", "example" : 0.9, "nullable" : true }, "maxEventDurationMs" : { "type" : "integer", "format" : "int32", "description" : "The max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", "example" : 15000, "nullable" : true }, "vehicleConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for vehicle detection. 0 or null means the built-in default.", "example" : 0.7, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetCameraDetailsWSRequest" : { "type" : "object", "description" : "Request to retrieve detailed information for multiple cameras.", "properties" : { "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to retrieve details for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Camera_GetCameraDetailsWSResponse" : { "type" : "object", "description" : "Response containing detailed information for multiple cameras.", "properties" : { "cameras" : { "type" : "array", "description" : "List of camera details", "items" : { "$ref" : "#/components/schemas/Camera_CameraExternalType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetCloudArchivedMediaInfoWSRequest" : { "type" : "object", "description" : "Request to retrieve cloud archived media information for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Camera_GetCloudArchivedMediaInfoWSResponse" : { "type" : "object", "description" : "Response containing cloud archived media information for a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "oldestArchivedVideoSegmentSecs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the oldest archived video segment in seconds since epoch", "example" : 1640995200, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetCloudArchivingConfigWSRequest" : { "type" : "object", "description" : "Request to get cloud archiving configuration.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GetCloudArchivingConfigWSResponse" : { "type" : "object", "description" : "Response containing cloud archiving configuration.", "properties" : { "archivingConfig" : { "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetConfigWSRequest" : { "type" : "object", "description" : "Request to retrieve camera configuration settings.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GetConfigWSResponse" : { "type" : "object", "description" : "Response containing camera configuration settings.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetCurrentStateWSRequest" : { "type" : "object", "description" : "Request to retrieve the current state of a camera (deprecated).", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "force" : { "type" : "boolean", "description" : "Whether to force a refresh of the camera state", "example" : false, "nullable" : true } } }, "Camera_GetCurrentStateWSResponse" : { "type" : "object", "description" : "Response containing the current state of a camera (deprecated).", "properties" : { "cameraState" : { "$ref" : "#/components/schemas/Camera_CameraCurrentStateType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetCustomFootageSeekpointsV2WSRequest" : { "type" : "object", "description" : "Request to retrieve custom footage seek points V2 for cameras within a time range.", "properties" : { "customDescription" : { "type" : "string", "description" : "Filters which custom footage seek point to search for by description", "example" : "Motion detected in camera view", "nullable" : true }, "customDisplayName" : { "type" : "string", "description" : "Filters which custom footage seek point to search for by name", "example" : "motion_event", "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to filter the search", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "duration" : { "type" : "integer", "format" : "int64", "description" : "How far from the start timestamp to search in seconds", "example" : 3600, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "List of location UUIDs to filter the search", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Starting timestamp of the search in UNIX seconds", "example" : 1640995200, "nullable" : true } } }, "Camera_GetCustomFootageSeekpointsV2WSResponse" : { "type" : "object", "description" : "Response containing custom footage seek points V2 for cameras.", "properties" : { "customFootageSeekPoints" : { "type" : "array", "description" : "List of custom footage seek points V2", "items" : { "$ref" : "#/components/schemas/SeekpointIndexType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFacetedCameraDetailsWSResponse" : { "type" : "object", "properties" : { "cameras" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Camera_CameraExternalFacetedType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFootageBoundingBoxesForMultipleWSRequest" : { "type" : "object", "description" : "Request to retrieve footage bounding boxes for multiple cameras within a time range.", "properties" : { "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to retrieve bounding boxes for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetFootageBoundingBoxesForMultipleWSResponse" : { "type" : "object", "description" : "Response containing footage bounding boxes for multiple cameras.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageBoundingBoxMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Camera_FootageBoundingBoxSummaryType" }, "description" : "Mapping of timestamps to footage bounding box summaries", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFootageBoundingBoxesWSRequest" : { "type" : "object", "description" : "Request to retrieve footage bounding boxes for a camera within a time range.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "duration" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetFootageBoundingBoxesWSResponse" : { "type" : "object", "description" : "Response containing footage bounding boxes for a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageBoundingBoxes" : { "type" : "array", "description" : "List of footage bounding boxes", "items" : { "$ref" : "#/components/schemas/FootageBoundingBoxType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFootageSeekpointsForMultipleWSRequest" : { "type" : "object", "description" : "Request to retrieve footage seek points for multiple cameras within a time range.", "properties" : { "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to retrieve seek points for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "description" : "Whether to include any motion events", "example" : true, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetFootageSeekpointsForMultipleWSResponse" : { "type" : "object", "description" : "Response containing footage seek points for multiple cameras.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageSeekPointMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Camera_FootageSeekPointSummaryType" }, "description" : "Mapping of timestamps to footage seek point summaries", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFootageSeekpointsV2WSRequest" : { "type" : "object", "description" : "Request to retrieve footage seek points V2 for a camera within a time range.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "duration" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "description" : "Whether to include any motion events", "example" : true, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetFootageSeekpointsV2WSResponse" : { "type" : "object", "description" : "Response containing footage seek points V2 for a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageSeekPoints" : { "type" : "array", "description" : "List of footage seek points V2", "items" : { "$ref" : "#/components/schemas/FootageSeekPointV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFootageSeekpointsWSRequest" : { "type" : "object", "description" : "Request to retrieve footage seek points for a camera within a time range (deprecated).", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "duration" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetFootageSeekpointsWSResponse" : { "type" : "object", "description" : "Response containing footage seek points for a camera (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageSeekPoints" : { "type" : "array", "description" : "List of footage seek points", "items" : { "$ref" : "#/components/schemas/FootageSeekPointType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetFullCameraStateWSRequest" : { "type" : "object", "description" : "Request to retrieve the full state information of a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "force" : { "type" : "boolean", "description" : "Whether to force a refresh of the camera state", "example" : false, "nullable" : true } } }, "Camera_GetFullCameraStateWSResponse" : { "type" : "object", "description" : "Response containing the full state information of a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "fullCameraState" : { "$ref" : "#/components/schemas/FullDeviceStateType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetLineCrossingEnabledCamerasForLocationWSRequest" : { "type" : "object", "description" : "Request to get line crossing enabled cameras for a location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GetLineCrossingEnabledCamerasForLocationWSResponse" : { "type" : "object", "description" : "Response containing line crossing enabled cameras for a location.", "properties" : { "camerasToConfigs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" }, "description" : "Map of camera UUIDs to their line crossing configurations", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetLineCrossingEnabledCamerasWSRequest" : { "type" : "object", "description" : "Request to get all line crossing enabled cameras in the org." }, "Camera_GetLineCrossingEnabledCamerasWSResponse" : { "type" : "object", "description" : "Response containing all line crossing enabled cameras in the org.", "properties" : { "camerasToConfigs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" }, "description" : "Map of camera UUIDs to their line crossing configurations", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetMediaUrisWSRequest" : { "type" : "object", "description" : "Request to get media URIs for a camera device.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "includePtzCapabilities" : { "type" : "boolean", "nullable" : true } } }, "Camera_GetMediaUrisWSResponse" : { "type" : "object", "description" : "Response containing media URIs for camera streaming and playback.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lanCheckUrls" : { "type" : "array", "description" : "List of LAN check URLs to verify device availability", "items" : { "type" : "string", "description" : "List of LAN check URLs to verify device availability", "nullable" : true }, "nullable" : true }, "lanLiveH264Uris" : { "type" : "array", "description" : "List of LAN H.264 live streaming URIs", "items" : { "type" : "string", "description" : "List of LAN H.264 live streaming URIs", "nullable" : true }, "nullable" : true }, "lanLiveM3u8Uris" : { "type" : "array", "description" : "List of LAN M3U8 live streaming URIs", "items" : { "type" : "string", "description" : "List of LAN M3U8 live streaming URIs", "nullable" : true }, "nullable" : true }, "lanLiveMpdUris" : { "type" : "array", "description" : "List of LAN MPD live streaming URIs", "items" : { "type" : "string", "description" : "List of LAN MPD live streaming URIs", "nullable" : true }, "nullable" : true }, "lanLiveOpusUris" : { "type" : "array", "description" : "List of LAN URIs for live Opus audio streams", "items" : { "type" : "string", "description" : "List of LAN URIs for live Opus audio streams", "nullable" : true }, "nullable" : true }, "lanVodM3u8UrisTemplates" : { "type" : "array", "description" : "List of LAN M3U8 VOD URI templates", "items" : { "type" : "string", "description" : "List of LAN M3U8 VOD URI templates", "nullable" : true }, "nullable" : true }, "lanVodMpdUrisTemplates" : { "type" : "array", "description" : "List of LAN MPD VOD URI templates", "items" : { "type" : "string", "description" : "List of LAN MPD VOD URI templates", "nullable" : true }, "nullable" : true }, "ptzCapabilities" : { "$ref" : "#/components/schemas/OnvifPtzCapabilitiesResponse" }, "wanLiveH264Uri" : { "type" : "string", "description" : "WAN H.264 live streaming URI", "example" : "rtsp://camera.example.com/live", "nullable" : true }, "wanLiveM3u8Uri" : { "type" : "string", "description" : "WAN M3U8 live streaming URI", "example" : "https://camera.example.com/live.m3u8", "nullable" : true }, "wanLiveMpdUri" : { "type" : "string", "description" : "WAN MPD live streaming URI", "example" : "https://camera.example.com/live.mpd", "nullable" : true }, "wanLiveOpusUri" : { "type" : "string", "description" : "WAN URI for live Opus audio stream", "nullable" : true }, "wanPtzControlUri" : { "type" : "string", "nullable" : true }, "wanVodH264UriTemplate" : { "type" : "string", "description" : "WAN H.264 VOD URI template", "example" : "https://camera.example.com/vod/{timestamp}.h264", "nullable" : true }, "wanVodM3u8UriTemplate" : { "type" : "string", "description" : "WAN M3U8 VOD URI template", "example" : "https://camera.example.com/vod/{timestamp}.m3u8", "nullable" : true }, "wanVodMpdUriTemplate" : { "type" : "string", "description" : "WAN MPD VOD URI template", "example" : "https://camera.example.com/vod/{timestamp}.mpd", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetMinimalCameraLocationMapWSRequest" : { "type" : "object", "description" : "Request to retrieve a mapping of cameras to their location information." }, "Camera_GetMinimalCameraLocationMapWSResponse" : { "type" : "object", "description" : "Response containing a mapping of cameras to their location information.", "properties" : { "cameraLocationMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" }, "description" : "Mapping of camera UUIDs to location information", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" : { "type" : "object", "description" : "Information about a camera's location.", "properties" : { "cameraName" : { "type" : "string", "description" : "Name of the camera", "example" : "Front Door Camera", "nullable" : true }, "locationName" : { "type" : "string", "description" : "Name of the location", "example" : "Main Building", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_GetMinimalCameraStateListWSRequest" : { "type" : "object", "description" : "Request to retrieve a minimal list of camera states.", "properties" : { "includeMummified" : { "type" : "boolean", "description" : "Whether to include mummified cameras in the response", "example" : false, "nullable" : true } } }, "Camera_GetMinimalCameraStateListWSResponse" : { "type" : "object", "description" : "Response containing a minimal list of camera states.", "properties" : { "cameraStates" : { "type" : "array", "description" : "List of minimal camera state information", "items" : { "$ref" : "#/components/schemas/MinimalDeviceStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetMinimalListWSRequest" : { "type" : "object", "description" : "Request to retrieve a minimal list of cameras (deprecated).", "properties" : { "includeMummified" : { "type" : "boolean", "description" : "Whether to include mummified cameras in the response", "example" : false, "nullable" : true } } }, "Camera_GetMinimalListWSResponse" : { "type" : "object", "description" : "Response containing a minimal list of cameras (deprecated).", "properties" : { "cameras" : { "type" : "array", "description" : "List of minimal camera information", "items" : { "$ref" : "#/components/schemas/Camera_MinimalCameraType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetOccupancyEnabledCamerasWSRequest" : { "type" : "object", "description" : "Request to get occupancy enabled cameras." }, "Camera_GetOfflineLanStreamingInfoWSRequest" : { "type" : "object", "description" : "Request to retrieve offline LAN streaming information for cameras." }, "Camera_GetOfflineLanStreamingInfoWSResponse" : { "type" : "object", "description" : "Response containing offline LAN streaming information for cameras.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "info" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Camera_CameraOfflineLanStreamingInfo" }, "description" : "Mapping of camera UUIDs to offline LAN streaming information", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetOngoingInactivityWindowsWSRequest" : { "type" : "object", "description" : "Request to retrieve currently ongoing inactivity windows for cameras.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to look up ongoing inactivity windows for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true } } }, "Camera_GetOngoingInactivityWindowsWSResponse" : { "type" : "object", "description" : "Response containing the currently ongoing inactivity windows for the requested cameras.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ongoingWindows" : { "type" : "array", "description" : "Currently ongoing inactivity windows for the requested cameras.", "items" : { "$ref" : "#/components/schemas/Camera_OngoingInactivityWindowType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetPresenceWindowsWSRequest" : { "type" : "object", "description" : "Request to retrieve presence windows for a camera within a time range.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int64", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Camera_GetPresenceWindowsWSResponse" : { "type" : "object", "description" : "Response containing presence windows for a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "presenceWindows" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Mapping of presence types to time windows", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "description" : "Mapping of presence types to time windows", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetSharedCameraCurrentStateWSResponse" : { "type" : "object", "properties" : { "cameraState" : { "$ref" : "#/components/schemas/Camera_SharedCameraCurrentStateType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetStorageRecoveryFileWSRequest" : { "type" : "object", "description" : "Request to get storage recovery file for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Camera_GetStorageRecoveryFileWSResponse" : { "type" : "object", "description" : "Response containing storage recovery file contents.", "properties" : { "fileContents" : { "type" : "array", "description" : "Binary contents of the storage recovery file", "example" : "[binary data]", "items" : { "type" : "string", "format" : "byte", "description" : "Binary contents of the storage recovery file", "example" : "W2JpbmFyeSBkYXRhXQ==", "nullable" : true }, "nullable" : true } } }, "Camera_GetUptimeWindowsWSRequest" : { "type" : "object", "description" : "Request to retrieve uptime windows for a camera within a time range.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endTime" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds since epoch", "example" : 1641081600000, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds since epoch", "example" : 1640995200000, "nullable" : true } } }, "Camera_GetUptimeWindowsWSResponse" : { "type" : "object", "description" : "Response containing uptime windows for a camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uptimeWindows" : { "type" : "array", "description" : "List of uptime windows", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_GetVideoWallsWSRequest" : { "type" : "object", "description" : "Request to retrieve all video wall configurations." }, "Camera_GetVideoWallsWSResponse" : { "type" : "object", "description" : "Response containing video wall configurations and associated user name mappings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "userNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Mapping of user UUIDs to user names", "nullable" : true }, "description" : "Mapping of user UUIDs to user names", "nullable" : true }, "videoWalls" : { "type" : "array", "description" : "List of video wall summary information", "items" : { "$ref" : "#/components/schemas/Camera_VideoWallSummaryType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_HealthStatusDetailsEnum" : { "type" : "string", "description" : "Detailed health status enumeration for cameras.", "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NONE" ] }, "Camera_MinimalCameraType" : { "type" : "object", "description" : "Minimal camera information type.", "properties" : { "connectionStatus" : { "$ref" : "#/components/schemas/Camera_StatusEnum" }, "defaultInterface" : { "type" : "string", "description" : "Default network interface", "example" : "eth0", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "description" : "MAC address of default interface", "example" : "00:11:22:33:44:55", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the camera is located", "example" : 1, "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/Camera_StatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" }, "lanAddresses" : { "type" : "array", "description" : "List of LAN addresses", "items" : { "type" : "string", "description" : "List of LAN addresses", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the camera", "example" : 37.7749, "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "description" : "Whether live stream is shared", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the camera", "example" : -122.4194, "nullable" : true }, "mediaRegion" : { "type" : "string", "description" : "Media region", "example" : "us-west-1", "nullable" : true }, "mummified" : { "type" : "boolean", "description" : "Whether the camera is mummified", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the camera", "example" : "Front Door Camera", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "description" : "Camera region", "example" : "us-west-1", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Camera serial number", "example" : "CAM123456789", "nullable" : true }, "ssid" : { "type" : "string", "description" : "WiFi SSID", "example" : "MyNetwork", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "description" : "MAC address of WiFi access point", "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "description" : "WiFi signal strength in bars (1-5)", "example" : 4, "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "description" : "WiFi signal strength in dBm", "example" : -45, "nullable" : true } } }, "Camera_OngoingInactivityWindowType" : { "type" : "object", "description" : "A single currently ongoing inactivity window for a camera region.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "facetUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "objectType" : { "$ref" : "#/components/schemas/InactivityObjectTypeEnum" }, "windowStartMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds at which the ongoing inactivity window started.", "nullable" : true } } }, "Camera_RebootCameraWSRequest" : { "type" : "object", "description" : "Request to reboot a camera device.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Camera_RebootCameraWSResponse" : { "type" : "object", "description" : "Response from rebooting a camera device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/Camera_RebootWSResponseStatus" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_RebootWSResponseStatus" : { "type" : "string", "description" : "Status enumeration for reboot web service responses.", "enum" : [ "SUCCESS_REBOOT_SENT", "FAILED_CAMERA_OFFLINE", "FAILED_CAMERA_NOT_AUTHORIZED" ] }, "Camera_ReportBadDetectionWSRequest" : { "type" : "object", "description" : "Request object for reporting a bad AI detection.", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "reason" : { "$ref" : "#/components/schemas/DetectionFeedbackReasonEnum" }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Time of the detection (or missed activity) in milliseconds since epoch", "nullable" : true }, "userDescription" : { "type" : "string", "description" : "Optional freeform note from the reporter", "nullable" : true } }, "required" : [ "activity", "cameraUuid", "reason", "timestampMs" ] }, "Camera_ReportBadDetectionWSResponse" : { "type" : "object", "description" : "Response object for reporting a bad AI detection.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_RevertCameraToDefaultsWSRequest" : { "type" : "object", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_RevertCameraToDefaultsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_SharedCameraCurrentStateType" : { "type" : "object", "description" : "Current state information for a shared camera.", "properties" : { "baseVideoOperationUrl" : { "type" : "string", "description" : "Base URL for video operations", "example" : "https://api.example.com/video", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/ConnectivityStatus" }, "oldestArchivedMediaSeconds" : { "type" : "integer", "format" : "int64", "description" : "Oldest archived media timestamp in seconds", "example" : 1640995200, "nullable" : true }, "onCameraState" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "State information stored on the camera", "nullable" : true }, "description" : "State information stored on the camera", "nullable" : true }, "onCloudState" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "State information stored in the cloud", "nullable" : true }, "description" : "State information stored in the cloud", "nullable" : true }, "region" : { "type" : "string", "description" : "Camera region", "example" : "us-west-1", "nullable" : true } } }, "Camera_SharedLiveVideoStreamWS" : { "type" : "object", "description" : "List of shared live video streams for the doorbell camera", "properties" : { "audioDeviceHwVar" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "audioGatewayUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "audioPushToTalkEnabled" : { "type" : "boolean", "nullable" : true }, "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "deviceHwVar" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "expirationTime" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hideOverlay" : { "type" : "boolean", "nullable" : true }, "invertSchedule" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "passwordProtected" : { "type" : "boolean", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sharedLiveM3U8StreamUrl" : { "type" : "string", "nullable" : true }, "sharedLiveVideoStreamUrl" : { "type" : "string", "nullable" : true }, "sharedWithMonitoringService" : { "type" : "boolean", "nullable" : true }, "ssoProtected" : { "type" : "boolean", "nullable" : true }, "streamType" : { "$ref" : "#/components/schemas/StreamTypeEnum" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "unscheduledMessage" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "vodEnabled" : { "type" : "boolean", "nullable" : true } } }, "Camera_SharedVideoWallWS" : { "type" : "object", "description" : "List of shared video walls", "properties" : { "deviceScheduleMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DeviceSchedule" }, "nullable" : true }, "expirationTime" : { "type" : "integer", "format" : "int32", "nullable" : true }, "hideOverlay" : { "type" : "boolean", "nullable" : true }, "invertSchedule" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "passwordProtected" : { "type" : "boolean", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sharedVideoWallUrl" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "unscheduledMessage" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "vodEnabled" : { "type" : "boolean", "nullable" : true } } }, "Camera_StatusEnum" : { "type" : "string", "description" : "Status enumeration for camera states.", "enum" : [ "RED", "ORANGE", "GREEN" ] }, "Camera_UpdateCameraAIThresholdsWSRequest" : { "type" : "object", "description" : "Request to update AI thresholds for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "consecutiveHumanFilter" : { "type" : "integer", "format" : "int32", "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", "example" : 3, "nullable" : true }, "consecutiveVehicleFilter" : { "type" : "integer", "format" : "int32", "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", "example" : 3, "nullable" : true }, "faceConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for face detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.7", "example" : 0.8, "nullable" : true }, "faceMatchConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for face matching (determining if two faces are the same person). Set to 0 or null to use the default. Maximum range of 1. Default = 0.7. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", "example" : 0.8, "nullable" : true }, "humanConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for human detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", "example" : 0.7, "nullable" : true }, "lprConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for license plate detection and character recognition. Set to 0 or null to use the default. Maximum range of 1. Default = 0.8", "example" : 0.9, "nullable" : true }, "maxEventDurationMs" : { "type" : "integer", "format" : "int32", "description" : "Set the max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", "example" : 15000, "nullable" : true }, "vehicleConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Confidence threshold for vehicle detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", "example" : 0.7, "nullable" : true } } }, "Camera_UpdateCameraAIThresholdsWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera AI thresholds.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraFirmwareWSRequest" : { "type" : "object", "description" : "Request to update camera firmware.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_UpdateCameraFirmwareWSResponse" : { "type" : "object", "description" : "Response containing the status of camera firmware update.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/Camera_UpdateFirmwareWSStatus" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraHumanLoiteringConfigWSRequest" : { "type" : "object", "description" : "Request to update human loitering configuration for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "rois" : { "type" : "array", "description" : "Region of interests of the human loitering feature. NULL or empty list will disable the feature", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true } } }, "Camera_UpdateCameraHumanLoiteringWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera human loitering configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraInactivityConfigWSRequest" : { "type" : "object", "description" : "Request to update inactivity detection configuration for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "objectType" : { "$ref" : "#/components/schemas/InactivityObjectTypeEnum" }, "roi" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "thresholdMs" : { "type" : "integer", "format" : "int64", "description" : "Inactivity duration in milliseconds that generates timeline events. Must be positive when configuring the feature. NULL will disable the feature.", "nullable" : true } } }, "Camera_UpdateCameraInactivityWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera inactivity detection configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraLineCrossingThresholdsWSRequest" : { "type" : "object", "description" : "Request to update line crossing thresholds for a camera.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "directions" : { "type" : "array", "description" : "Set of crossing directions to monitor.", "items" : { "$ref" : "#/components/schemas/CrossingDirectionEnum" }, "nullable" : true, "uniqueItems" : true }, "inverted" : { "type" : "boolean", "description" : "By default, INGRESS events occur when the following condition is met for the following line types: an entity moves from top -> bottom when a horizontal line is defined, an entity moves from left -> right when a vertical line is defined, an entity moves from top-left -> bottom-right when an upwards sloping line is defined, and an entity moves from top-right to bottom-left when a downwards sloping line is defined. Setting this value to true will switch INGRESS to EGRESS events and vice-versa.", "example" : false, "nullable" : true }, "objectType" : { "$ref" : "#/components/schemas/CrossingObjectEnum" }, "pointA" : { "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" }, "pointB" : { "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" } } }, "Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" : { "type" : "object", "description" : "(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable line-crossing.", "properties" : { "x" : { "type" : "number", "format" : "float", "description" : "Value ranges from 0.1 to 0.9", "example" : 0.5, "nullable" : true }, "y" : { "type" : "number", "format" : "float", "description" : "Value ranges from 0.1 to 0.9", "example" : 0.5, "nullable" : true } } }, "Camera_UpdateCameraLineCrossingThresholdsWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera line crossing thresholds.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraV2WSRequest" : { "type" : "object", "description" : "Request to update camera information V2 with partial update support.", "properties" : { "customData" : { "type" : "string", "description" : "Custom data for the camera", "nullable" : true }, "customDataUpdated" : { "type" : "boolean", "description" : "Whether custom data was updated", "example" : false, "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the camera is deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "description" : "Whether deleted status was updated", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the camera", "example" : "Camera monitoring the front entrance", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "description" : "Whether description was updated", "example" : false, "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "description" : "Direction in radians", "example" : 1.5708, "nullable" : true }, "directionRadiansUpdated" : { "type" : "boolean", "description" : "Whether direction radians was updated", "example" : false, "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Mapping of device facets to names", "nullable" : true }, "description" : "Mapping of device facets to names", "nullable" : true }, "facetNameMapUpdated" : { "type" : "boolean", "description" : "Whether facet name map was updated", "example" : false, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number", "example" : 1, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "description" : "Whether floor number was updated", "example" : false, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "description" : "Whether latitude was updated", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "description" : "Whether location UUID was updated", "example" : false, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "description" : "Whether longitude was updated", "example" : false, "nullable" : true }, "mummified" : { "type" : "boolean", "description" : "Whether the camera is mummified", "example" : false, "nullable" : true }, "mummifiedUpdated" : { "type" : "boolean", "description" : "Whether mummified status was updated", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the camera", "example" : "Front Door Camera", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "description" : "Whether name was updated", "example" : false, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "description" : "Whether policy UUID was updated", "example" : false, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether sub-locations hierarchy key was updated", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Camera_UpdateCameraV2WSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera information V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCameraWSRequest" : { "type" : "object", "description" : "Request to update camera information (deprecated).", "properties" : { "camera" : { "$ref" : "#/components/schemas/Camera_CameraBackwardsCompatUpdateType" } } }, "Camera_UpdateCameraWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating camera information (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateCamerasBulkV2WSRequest" : { "type" : "object", "description" : "Request to update multiple cameras in bulk V2.", "properties" : { "cameraBulkDetails" : { "type" : "array", "description" : "List of camera bulk update details", "items" : { "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSRequest" }, "nullable" : true } } }, "Camera_UpdateConfigWSRequest" : { "type" : "object", "description" : "Request to update camera configuration settings.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" } } }, "Camera_UpdateFirmwareWSStatus" : { "type" : "string", "description" : "Status of the firmware update operation", "enum" : [ "ALREADY_ON_THE_LATEST_FIRMWARE", "DEVICE_ON_A_SPECIAL_FIRMWARE_AND_CANNOT_BE_UPDATED", "UPDATE_STARTED", "UNABLE_TO_REACH_DEVICE", "FIRMWARE_UPDATE_ALREADY_IN_PROGESS", "DEVICE_NOT_AUTHROIZED" ] }, "Camera_UpdateVideoWallWSRequest" : { "type" : "object", "description" : "Request to update a video wall configuration.", "properties" : { "videoWall" : { "$ref" : "#/components/schemas/VideoWallType" } } }, "Camera_UpdateVideoWallWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating a video wall configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_UpdateWifiWSRequest" : { "type" : "object", "description" : "Request to update WiFi settings for one or more cameras.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to update WiFi settings for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "password" : { "type" : "string", "description" : "WiFi network password", "example" : "password123", "nullable" : true }, "ssid" : { "type" : "string", "description" : "WiFi network SSID", "example" : "MyWiFiNetwork", "nullable" : true } } }, "Camera_UpdateWifiWSResponse" : { "type" : "object", "description" : "Response containing the status of WiFi update operations for each camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "description" : "Mapping of camera UUIDs to WiFi update success status", "nullable" : true }, "description" : "Mapping of camera UUIDs to WiFi update success status", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Camera_VideoWallSummaryType" : { "type" : "object", "description" : "Summary information for a video wall.", "properties" : { "deviceList" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "numShares" : { "type" : "integer", "format" : "int32", "description" : "Number of shares for the video wall", "example" : 5, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "othersCanEdit" : { "type" : "boolean", "nullable" : true }, "ownerUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "settings" : { "type" : "object", "additionalProperties" : { "type" : "object", "nullable" : true }, "nullable" : true }, "shared" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "CancelLoopingAudioPlaybackActionRecordType" : { "type" : "object", "properties" : { "statusMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AudioGatewayStatusEnum" }, "nullable" : true } } }, "CancelLoopingAudioPlaybackActionType" : { "type" : "object", "properties" : { "_audioDevices" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "audioDevices" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true } } }, "CancelledAccessStateOverride" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "cancelledDoorStateOverride" : { "$ref" : "#/components/schemas/AccessStateOverride" } } } ], "nullable" : true, "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" } } }, "ChangeComponentCompositeAccessStateActionType" : { "type" : "object", "properties" : { "accessState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "alwaysCreateOverrideIfNoFirstIn" : { "type" : "boolean", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "expirationStrategy" : { "$ref" : "#/components/schemas/AccessStateOverrideExpirationStrategyEnum" }, "expireTimeDelaySeconds" : { "type" : "integer", "format" : "int64", "nullable" : true }, "expireTimeOfDayLocalSeconds" : { "type" : "integer", "format" : "int64", "nullable" : true }, "useFirstInRulesIfPossible" : { "type" : "boolean", "nullable" : true }, "version" : { "type" : "integer", "format" : "int32", "nullable" : true, "readOnly" : true } } }, "ChangeComponentCompositeAccessStateRecordType" : { "type" : "object", "properties" : { "accessState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "madeChange" : { "type" : "boolean", "nullable" : true }, "succeeded" : { "type" : "boolean", "nullable" : true }, "usedFirstIn" : { "type" : "boolean", "nullable" : true }, "willExpireAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "ChangeTypeEnum" : { "type" : "string", "description" : "Change type enum for exposing to OpenAPI component schemas", "enum" : [ "REFRESH", "DELETE", "CREATE", "UPDATE" ] }, "ChatFollowUpActionEnum" : { "type" : "string", "enum" : [ "NOTIFY_USERS", "UNKNOWN" ] }, "ChatPrivacy" : { "type" : "object", "properties" : { "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "permittedPrincipalUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "visibility" : { "$ref" : "#/components/schemas/ChatVisibilityEnum" } } }, "ChatQueryFilter" : { "type" : "object", "description" : "Optional field for filtering chat records.", "properties" : { "afterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "beforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "responseTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResponseTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "responseTypesStr" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "ChatRecord" : { "type" : "object", "description" : "Chat record used for a selective update.", "properties" : { "attributedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "automatedPromptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "contextId" : { "type" : "string", "nullable" : true }, "extra" : { "type" : "string", "nullable" : true }, "llmInfo" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacy" : { "$ref" : "#/components/schemas/ChatPrivacy" }, "queriedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "query" : { "type" : "string", "nullable" : true }, "requestedBy" : { "$ref" : "#/components/schemas/RequestedBy" }, "respondedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "response" : { "type" : "string", "nullable" : true }, "responseType" : { "$ref" : "#/components/schemas/ResponseTypeEnum" }, "timeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryTimelineEvent" }, "nullable" : true }, "toolingTimeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryTool" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ChatVisibilityEnum" : { "type" : "string", "enum" : [ "PUBLIC", "ORG_WIDE", "SELECT_USERS", "PRIVATE" ] }, "ChatbotConfig" : { "type" : "object", "description" : "Rhombus MIND configuration to update.", "properties" : { "apiKey" : { "type" : "string", "description" : "LLM API key used by the chatbot service", "nullable" : true }, "billingType" : { "$ref" : "#/components/schemas/ChatbotConfigBillingTypeEnum" }, "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp in milliseconds when this config was created", "nullable" : true }, "executionStrategy" : { "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" }, "lastUpdatedByPrincipal" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenValid" : { "type" : "boolean", "description" : "Indicator if the provided LLM API key is valid", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp in milliseconds when this config was last updated", "nullable" : true } }, "required" : [ "billingType" ] }, "ChatbotConfigBillingTypeEnum" : { "type" : "string", "description" : "Billing type", "enum" : [ "SELF_MANAGED", "MANAGED", "TRIAL" ] }, "ChatbotExecutionStrategyEnum" : { "type" : "string", "description" : "Execution strategy for chat queries. Defaults to MIND_CHATGPT if not specified.", "enum" : [ "MIND_CHATGPT", "DIRECT_CHATGPT", "DIRECT_CLAUDE" ] }, "Chatbot_BaseAutomatedPromptWSResponse" : { "type" : "object", "description" : "Response object for creating, updating or retrieving chatbot automation settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "$ref" : "#/components/schemas/AutomatedPrompt" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_BaseChatWSResponse" : { "type" : "object", "description" : "Response object for retrieving or updating a chat record.", "properties" : { "chat" : { "$ref" : "#/components/schemas/ChatRecord" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_BaseChatbotConfigWSResponse" : { "type" : "object", "description" : "Response object for creating, updating or retrieving Rhombus MIND config.", "properties" : { "config" : { "$ref" : "#/components/schemas/ChatbotConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_CreateAutomatedPromptWSRequest" : { "type" : "object", "description" : "Request object for creating chatbot automation settings.", "properties" : { "settings" : { "$ref" : "#/components/schemas/AutomatedPrompt" } }, "required" : [ "settings" ] }, "Chatbot_CreateChatbotConfigWSRequest" : { "type" : "object", "description" : "Request object for creating Rhombus MIND config.", "properties" : { "config" : { "$ref" : "#/components/schemas/ChatbotConfig" } }, "required" : [ "config" ] }, "Chatbot_DeleteAutomatedPromptWSRequest" : { "type" : "object", "description" : "Request object for deleting chatbot automation settings.", "properties" : { "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "promptUuid" ] }, "Chatbot_DeleteChatRecordWSRequest" : { "type" : "object", "description" : "Request object for deleting a chat record.", "properties" : { "recordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "recordUuid" ] }, "Chatbot_DeleteChatbotConfigWSRequest" : { "type" : "object", "description" : "Request object for deleting Rhombus MIND config." }, "Chatbot_DeleteChatbotConversationWSRequest" : { "type" : "object", "description" : "Request object for deleting a user's conversation with Rhombus MIND.", "properties" : { "contextId" : { "type" : "string", "description" : "Context identifier of the conversation to delete.", "nullable" : true } }, "required" : [ "contextId" ] }, "Chatbot_GetAutomatedPromptChatHistoryWSRequest" : { "type" : "object", "description" : "Request object for retrieving chat history for a given automated prompt.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "promptUuid" ] }, "Chatbot_GetAutomatedPromptWSRequest" : { "type" : "object", "description" : "Request object for retrieving chatbot automation settings.", "properties" : { "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "promptUuid" ] }, "Chatbot_GetAutomatedPromptsForOrgWSResponse" : { "type" : "object", "description" : "Response object for retrieving chatbot automation settings for an org.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key to resume a paginated query.", "nullable" : true }, "settingsList" : { "type" : "array", "description" : "List of chatbot automation settings for this org.", "items" : { "$ref" : "#/components/schemas/AutomatedPrompt" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_GetChatHistoryByContextIdWSRequest" : { "type" : "object", "description" : "Request object for retrieving a user's chat history for a given conversation with Rhombus MIND.", "properties" : { "contextId" : { "type" : "string", "description" : "Context ID to get chat history for.", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } }, "required" : [ "contextId" ] }, "Chatbot_GetChatHistoryWSRequest" : { "type" : "object", "description" : "Request object for retrieving a user's entire chat history with Rhombus MIND.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ChatQueryFilter" }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Chatbot_GetChatHistoryWSResponse" : { "type" : "object", "description" : "Response object for retrieving an entity's chat history with Rhombus MIND.", "properties" : { "chatHistory" : { "type" : "array", "description" : "An entity's chat history with Rhombus MIND.", "items" : { "$ref" : "#/components/schemas/ChatRecord" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key to resume a paginated query.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_GetChatRecordWSRequest" : { "type" : "object", "description" : "Request object for retrieving a chat record.", "properties" : { "recordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "recordUuid" ] }, "Chatbot_GetChatbotConfigWSRequest" : { "type" : "object", "description" : "Request object for retrieving Rhombus MIND config." }, "Chatbot_GetChatbotConversationsWSRequest" : { "type" : "object", "description" : "Request object for retrieving a user's conversations with Rhombus MIND.", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Chatbot_GetChatbotConversationsWSResponse" : { "type" : "object", "description" : "Response object for retrieving a user's conversations with Rhombus MIND.", "properties" : { "conversations" : { "type" : "array", "description" : "List of a user's conversations.", "items" : { "$ref" : "#/components/schemas/ContextRecord" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key to resume a paginated query.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_GetPublicChatRecordWSRequest" : { "type" : "object", "description" : "Request object for retrieving a publicly viewable chat record.", "properties" : { "chatId" : { "type" : "string", "description" : "Base64-encoded chat record UUID.", "nullable" : true }, "orgId" : { "type" : "string", "description" : "Base64-encoded org UUID.", "nullable" : true } }, "required" : [ "chatId", "orgId" ] }, "Chatbot_GetRemainingTrialCreditsWSRequest" : { "type" : "object", "description" : "Request object for retrieving the current org's remaining trial credits for MIND." }, "Chatbot_GetRemainingTrialCreditsWSResponse" : { "type" : "object", "description" : "Response object for retrieving the current org's remaining trial credits for MIND.", "properties" : { "remainingTrialCredits" : { "type" : "integer", "format" : "int64", "description" : "The current org's remaining trial credits for MIND.", "nullable" : true } } }, "Chatbot_GetSharedChatRecordsWSRequest" : { "type" : "object", "description" : "Request object for retrieving chat records shared with the current user.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ChatQueryFilter" } } }, "Chatbot_GetSharedChatRecordsWSResponse" : { "type" : "object", "description" : "Response object for retrieving chat records shared with the current user.", "properties" : { "chatRecords" : { "type" : "array", "description" : "List of chat records shared with the current user.", "items" : { "$ref" : "#/components/schemas/ChatRecord" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_GetTokenUsageHistoryWSRequest" : { "type" : "object", "description" : "Request object for retrieving the current org's LLM token usage history." }, "Chatbot_GetTokenUsageHistoryWSResponse" : { "type" : "object", "description" : "Response object for retrieving the current org's LLM token usage history.", "properties" : { "usageHistory" : { "type" : "array", "description" : "The current org's LLM token usage history; one entry per (year, month, model) bucket.", "items" : { "$ref" : "#/components/schemas/TokenUsageStats" }, "nullable" : true } } }, "Chatbot_InterruptChatWSRequest" : { "type" : "object", "description" : "Request object for interrupting a chat record.", "properties" : { "recordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "recordUuid" ] }, "Chatbot_ShareAutomatedPromptResponseWSRequest" : { "type" : "object", "description" : "Request object for updating the visibility of an automated prompt response.", "properties" : { "chatUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "privacy" : { "$ref" : "#/components/schemas/ChatPrivacy" } }, "required" : [ "chatUuid", "privacy" ] }, "Chatbot_SubmitChatWSRequest" : { "type" : "object", "description" : "Request object for submitting a query to Rhombus MIND.", "properties" : { "contextId" : { "type" : "string", "description" : "Uuid used to track the current conversation with Rhombus MIND.", "nullable" : true }, "conversationName" : { "type" : "string", "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", "nullable" : true }, "query" : { "type" : "string", "description" : "The query to submit to Rhombus MIND.", "nullable" : true }, "voiceMode" : { "type" : "boolean", "description" : "Whether the query was submitted via voice mode.", "nullable" : true } }, "required" : [ "contextId", "query" ] }, "Chatbot_SubmitChatWSResponse" : { "type" : "object", "description" : "Response object for submitting a query to Rhombus MIND.", "nullable" : true, "properties" : { "chatRecordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_SubmitCreateReportWSRequest" : { "type" : "object", "description" : "Request object for submitting a report query to Rhombus MIND.", "properties" : { "contextId" : { "type" : "string", "description" : "Uuid used to track the current conversation with Rhombus MIND.", "nullable" : true }, "conversationName" : { "type" : "string", "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", "nullable" : true }, "query" : { "type" : "string", "description" : "The query to submit to Rhombus MIND.", "nullable" : true } }, "required" : [ "contextId", "query" ] }, "Chatbot_SubmitCreateReportWSResponse" : { "type" : "object", "description" : "Response object for submitting a report query to Rhombus MIND.", "properties" : { "chatRecordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_SubmitFillFormWSRequest" : { "type" : "object", "description" : "Request object for asking Rhombus MIND to fill in a form the user already has open.", "properties" : { "contextId" : { "type" : "string", "description" : "Uuid used to track the current exchange with Rhombus MIND. Refinements to the same form should reuse it so MIND can tell which fields the latest instruction is about.", "nullable" : true }, "conversationName" : { "type" : "string", "description" : "The name of the conversation if this fill is the start of a new conversation. If not specified, the conversation will be named after the first query.", "nullable" : true }, "query" : { "type" : "string", "description" : "What the user asked for, in their own words.", "nullable" : true }, "target" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "The form to fill: its id, title, the exact fields MIND may fill, and any values the form already holds. MIND may only fill fields declared here.", "nullable" : true }, "description" : "The form to fill: its id, title, the exact fields MIND may fill, and any values the form already holds. MIND may only fill fields declared here.", "nullable" : true } }, "required" : [ "contextId", "query", "target" ] }, "Chatbot_SubmitFillFormWSResponse" : { "type" : "object", "description" : "Response object for asking Rhombus MIND to fill in a form.", "properties" : { "chatRecordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_SubmitTestPromptWSRequest" : { "type" : "object", "description" : "Request object for submitting a test prompt with Rhombus MIND.", "properties" : { "responseTemplate" : { "type" : "string", "description" : "Template for Rhombus MIND to follow when generating a response.", "nullable" : true }, "testPrompt" : { "type" : "string", "description" : "Prompt to test with Rhombus MIND.", "nullable" : true } }, "required" : [ "testPrompt" ] }, "Chatbot_SubmitTestPromptWSResponse" : { "type" : "object", "description" : "Response object for submitting a test prompt with Rhombus MIND.", "properties" : { "chatUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_UpdateAutomatedPromptWSRequest" : { "type" : "object", "description" : "Request object for updating chatbot automation settings.", "properties" : { "selectiveUpdate" : { "$ref" : "#/components/schemas/AutomatedPrompt" } }, "required" : [ "selectiveUpdate" ] }, "Chatbot_UpdateChatRecordWSRequest" : { "type" : "object", "description" : "Request object for selectively updating a chat record.", "properties" : { "chat" : { "$ref" : "#/components/schemas/ChatRecord" } }, "required" : [ "chat" ] }, "Chatbot_UpdateChatbotConfigWSRequest" : { "type" : "object", "description" : "Request object for updating Rhombus MIND config.", "properties" : { "config" : { "$ref" : "#/components/schemas/ChatbotConfig" } }, "required" : [ "config" ] }, "Chatbot_UpdateChatbotConversationWSRequest" : { "type" : "object", "description" : "Request object for selectively updating a user's conversation with Rhombus MIND.", "properties" : { "selectiveUpdate" : { "$ref" : "#/components/schemas/ContextRecordSelectiveUpdate" } } }, "Chatbot_UpdateChatbotConversationsWSResponse" : { "type" : "object", "description" : "Response object for updating a user's conversation with Rhombus MIND.", "properties" : { "conversation" : { "$ref" : "#/components/schemas/ContextRecord" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_VerifyJobScheduledWSRequest" : { "type" : "object", "description" : "Request object for rescheduling an automated prompt that became inactive.", "properties" : { "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "promptUuid" ] }, "Chatbot_VerifyJobScheduledWSResponse" : { "type" : "object", "description" : "Response object for rescheduling an automated prompt that became inactive.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "scheduleExpression" : { "type" : "string", "description" : "Schedule expression when this automated prompt will trigger.", "nullable" : true }, "scheduleTimezone" : { "type" : "string", "description" : "Timezone the schedule expression is in.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_AddAIReportTimelineEventWSRequest" : { "type" : "object", "description" : "Request object for adding a timeline event to an AI report", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/QueryStatusEnum" }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds for the timeline event", "nullable" : true } } }, "Chatbot_report_BaseAIReportGroupWSResponse" : { "type" : "object", "description" : "Response object for retrieving or updating an AI report group", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "group" : { "$ref" : "#/components/schemas/AIReportGroup" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_BaseAIReportWSResponse" : { "type" : "object", "description" : "Response object for retrieving or updating an AI report", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "report" : { "$ref" : "#/components/schemas/AIReport" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_CreateReportWSRequest" : { "type" : "object", "description" : "Request object for generating an AI report.", "properties" : { "params" : { "$ref" : "#/components/schemas/AIReportGenerateParams" }, "privacy" : { "$ref" : "#/components/schemas/ChatPrivacy" } }, "required" : [ "params", "privacy" ] }, "Chatbot_report_CreateReportWSResponse" : { "type" : "object", "description" : "Response object for generating an AI report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_DeleteAIReportGroupWSRequest" : { "type" : "object", "description" : "Request object for deleting an AI report group", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Chatbot_report_DeleteAIReportWSRequest" : { "type" : "object", "description" : "Request object for deleting an AI report", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Chatbot_report_GetAIReportGroupsByOrgWSRequest" : { "type" : "object", "description" : "Request object for retrieving AI report groups by organization", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Chatbot_report_GetAIReportGroupsByOrgWSResponse" : { "type" : "object", "description" : "Response object for retrieving AI report groups by organization UUID", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "groups" : { "type" : "array", "description" : "List of AI reports", "items" : { "$ref" : "#/components/schemas/AIReportGroup" }, "nullable" : true }, "lastEvaluatedKey" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_GetAIReportWSRequest" : { "type" : "object", "description" : "Request object for retrieving an AI report", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Chatbot_report_GetAIReportsByGroupWSRequest" : { "type" : "object", "description" : "Request object for retrieving AI reports by group", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Chatbot_report_GetAIReportsByGroupWSResponse" : { "type" : "object", "description" : "Response object for retrieving AI reports by group", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "reports" : { "type" : "array", "description" : "List of AI reports", "items" : { "$ref" : "#/components/schemas/AIReport" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_GetAIReportsByOrgWSRequest" : { "type" : "object", "description" : "Request object for retrieving AI reports by organization", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Chatbot_report_GetAIReportsByOrgWSResponse" : { "type" : "object", "description" : "Response object for retrieving AI reports by organization", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "reports" : { "type" : "array", "description" : "List of AI reports", "items" : { "$ref" : "#/components/schemas/AIReport" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Chatbot_report_UpdateAIReportWSRequest" : { "type" : "object", "description" : "Request object for updating an AI report", "properties" : { "report" : { "$ref" : "#/components/schemas/AIReport" } } }, "CheckCondition" : { "type" : "object", "nullable" : true, "properties" : { "operator" : { "$ref" : "#/components/schemas/OPERATOREnum" }, "value" : { "type" : "string", "nullable" : true } } }, "ClaimKey" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "entry" : { "$ref" : "#/components/schemas/ClaimKeyEntry" }, "migratedRenewal" : { "type" : "boolean", "nullable" : true }, "startDate" : { "type" : "string", "format" : "date-time", "nullable" : true } } } ], "nullable" : true, "properties" : { "claimEndDate" : { "type" : "string", "format" : "date-time", "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", "nullable" : true }, "claimStartDate" : { "type" : "string", "format" : "date-time", "description" : "Date/time when claiming of licenses represented by this claim key started.", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "endDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "expirationEmailState" : { "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" }, "gracePeriodEndDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "maskedClaimCode" : { "type" : "string", "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "renewedByClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "requestId" : { "type" : "string", "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", "nullable" : true }, "returnHistory" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimKeyReturnEvent" }, "nullable" : true }, "state" : { "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ClaimKeyTypeEnum" }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ClaimKeyEntry" : { "type" : "object", "nullable" : true, "properties" : { "productQuantities" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true } } }, "ClaimKeyExpirationEmailStateEnum" : { "type" : "string", "enum" : [ "NINETY_DAY_EMAIL_SUCCEEDED", "NINETY_DAY_EMAIL_FAILED", "SIXTY_DAY_EMAIL_SUCCEEDED", "SIXTY_DAY_EMAIL_FAILED", "FOURTY_FIVE_DAY_EMAIL_SUCCEEDED", "FOURTY_FIVE_DAY_EMAIL_FAILED", "THIRTY_DAY_EMAIL_SUCCEEDED", "THIRTY_DAY_EMAIL_FAILED", "TWENTY_ONE_DAY_EMAIL_SUCCEEDED", "TWENTY_ONE_DAY_EMAIL_FAILED", "FOURTEEN_DAY_EMAIL_SUCCEEDED", "FOURTEEN_DAY_EMAIL_FAILED", "TEN_DAY_EMAIL_SUCCEEDED", "TEN_DAY_EMAIL_FAILED", "FIVE_DAY_EMAIL_SUCCEEDED", "FIVE_DAY_EMAIL_FAILED", "FOUR_DAY_EMAIL_SUCCEEDED", "FOUR_DAY_EMAIL_FAILED", "THREE_DAY_EMAIL_SUCCEEDED", "THREE_DAY_EMAIL_FAILED", "TWO_DAY_EMAIL_SUCCEEDED", "TWO_DAY_EMAIL_FAILED", "ONE_DAY_EMAIL_SUCCEEDED", "ONE_DAY_EMAIL_FAILED", "ZERO_DAY_EMAIL_SUCCEEDED", "ZERO_DAY_EMAIL_FAILED", "GRACE_PERIOD_EMAILS_IN_PROGRESS", "GRACE_PERIOD_EMAILS_COMPLETED", "UNKNOWN" ] }, "ClaimKeyReturnEvent" : { "type" : "object", "properties" : { "returnedProductQuantities" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "timestamp" : { "type" : "string", "format" : "date-time", "nullable" : true } } }, "ClaimKeySearchFilter" : { "type" : "object", "properties" : { "excludeUnclaimed" : { "type" : "boolean", "nullable" : true }, "excludedStates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "nullable" : true, "uniqueItems" : true }, "includedStates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "nullable" : true, "uniqueItems" : true } } }, "ClaimKeyStateEnum" : { "type" : "string", "enum" : [ "CREATED", "CLAIMING_PENDING", "CLAIMING_IN_PROGRESS", "CLAIMING_FAILED", "CLAIMED", "EXPIRED_UNCLAIMED", "EXPIRED", "RETURNED", "RENEWED" ] }, "ClaimKeyTypeEnum" : { "type" : "string", "enum" : [ "NEW", "RENEWAL" ] }, "ClientEnum" : { "type" : "string", "enum" : [ "DEVICE", "MOBILE", "BROWSER", "BROWSER_V2", "BROWSER_PARTNER", "MOBILE_PARTNER", "ANONYMOUS", "SHARE_ANONYMOUS", "SHARE_ANONYMOUS_V2", "SHARE_RAW", "SHARE_SSO", "TV_API", "DOOR_STATION_API", "API", "API_TOKEN", "API_OAUTH_TOKEN", "FEDERATED_TOKEN", "PARTNER_API", "PARTNER_API_TOKEN", "PARTNER_API_OAUTH_TOKEN", "KEYPAD_API", "INTERNAL_SALESFORCE", "RHOMBUS_KEY_MOBILE", "KIOSK_CONSOLE", "KIOSK_IOS_API", "CHATBOT" ] }, "ClimateActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "climateThreshold" : { "type" : "number", "format" : "float", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "ClimateEventType" : { "type" : "object", "description" : "List of climate events for the sensor", "properties" : { "alertActivities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "baseStationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "batteryPercentage" : { "type" : "integer", "format" : "int32", "nullable" : true }, "bleDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "bleRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "closeBaseStations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "co2" : { "type" : "number", "format" : "float", "nullable" : true }, "ethanol" : { "type" : "number", "format" : "float", "nullable" : true }, "heatIndexDegF" : { "type" : "number", "format" : "double", "nullable" : true }, "heatIndexRangeWarning" : { "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" }, "humidity" : { "type" : "number", "format" : "float", "nullable" : true }, "iaq" : { "type" : "number", "format" : "float", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pm25" : { "type" : "number", "format" : "float", "nullable" : true }, "probeTempC" : { "type" : "number", "format" : "float", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "tampered" : { "type" : "boolean", "nullable" : true }, "temp" : { "type" : "number", "format" : "float", "nullable" : true }, "thcDetected" : { "type" : "boolean", "nullable" : true }, "thcPercent" : { "type" : "number", "format" : "float", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "tvoc" : { "type" : "number", "format" : "float", "nullable" : true }, "vapeSmokeDetected" : { "type" : "boolean", "nullable" : true }, "vapeSmokePercent" : { "type" : "number", "format" : "float", "nullable" : true } } }, "ClimatePolicyType" : { "type" : "object", "description" : "List of climate policies using the schedule", "properties" : { "backoffAlertSecs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "defaultTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClimateTriggerType" }, "nullable" : true, "uniqueItems" : true }, "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClimateScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ClimateScheduledTriggerType" : { "type" : "object", "properties" : { "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClimateTriggerType" }, "nullable" : true, "uniqueItems" : true } } }, "ClimateSettings" : { "type" : "object", "properties" : { "alert_window_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "smoke_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "thc_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vape_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "ClimateSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Sensor Climate settings", "properties" : { "alert_window_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "smoke_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "thc_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "vape_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "ClimateTriggerType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "Climate_ClimateHealthDetailsEnum" : { "type" : "string", "description" : "Detailed health status enumeration for climate sensors.", "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] }, "Climate_ClimateHealthEnum" : { "type" : "string", "description" : "Health status enumeration for climate sensors.", "enum" : [ "GREEN", "RED" ] }, "Climate_DeleteEnvironmentalGatewayWSRequest" : { "type" : "object", "description" : "Request to delete an environmental gateway.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Whether to mummify the gateway instead of deleting it", "example" : false, "nullable" : true } } }, "Climate_DeleteEnvironmentalGatewayWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting an environmental gateway.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_GetClimateEventsForSensorWSRequest" : { "type" : "object", "description" : "Request to retrieve climate events for an environmental sensor.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds after which events should be retrieved", "example" : 1640991600000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds before which events should be retrieved", "example" : 1640995200000, "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of events to return", "example" : 100, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Climate_GetClimateEventsForSensorWSResponse" : { "type" : "object", "description" : "Response containing climate events for an environmental sensor.", "properties" : { "climateEvents" : { "type" : "array", "description" : "List of climate events for the sensor", "items" : { "$ref" : "#/components/schemas/ClimateEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_GetClimateSensorConfigWSRequest" : { "type" : "object", "description" : "Request to retrieve configuration for an environmental sensor.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Climate_GetClimateSensorConfigWSResponse" : { "type" : "object", "description" : "Response containing configuration for an environmental sensor.", "properties" : { "config" : { "$ref" : "#/components/schemas/IClimateUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_GetEnvironmentalGatewayShadowsWSRequest" : { "type" : "object", "description" : "Request to retrieve environmental gateway shadows." }, "Climate_GetEnvironmentalGatewayShadowsWSResponse" : { "type" : "object", "description" : "Response containing environmental gateway shadows.", "properties" : { "environmentalGatewayShadows" : { "type" : "array", "description" : "List of environmental gateway shadows", "items" : { "$ref" : "#/components/schemas/EnvironmentalGatewayShadowType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_GetEventsForEnvironmentalGatewayWSRequest" : { "type" : "object", "description" : "Request to retrieve events for an environmental gateway.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds after which events should be retrieved", "example" : 1640991600000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds before which events should be retrieved", "example" : 1640995200000, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return per page", "example" : 50, "nullable" : true } } }, "Climate_GetEventsForEnvironmentalGatewayWSResponse" : { "type" : "object", "description" : "Response containing events for an environmental gateway.", "properties" : { "events" : { "type" : "array", "description" : "List of climate events for the environmental gateway", "items" : { "$ref" : "#/components/schemas/E50ClimateEventType" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Climate_GetMinimalClimateStatesWSRequest" : { "type" : "object", "description" : "Request to retrieve minimal climate state information for all environmental sensors." }, "Climate_GetMinimalClimateStatesWSResponse" : { "type" : "object", "description" : "Response containing minimal climate state information for environmental sensors.", "properties" : { "climateStates" : { "type" : "array", "description" : "List of minimal climate state information", "items" : { "$ref" : "#/components/schemas/Climate_MinimalClimateStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_GetMinimalEnvironmentalGatewayStatesWSRequest" : { "type" : "object", "description" : "Request to retrieve minimal environmental gateway states." }, "Climate_GetMinimalEnvironmentalGatewayStatesWSResponse" : { "type" : "object", "description" : "Response containing minimal environmental gateway states.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "minimalEnvironmentalGatewayStates" : { "type" : "array", "description" : "List of minimal environmental gateway states", "items" : { "$ref" : "#/components/schemas/Climate_MinimalEnvironmentalGatewayStateType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_MinimalClimateStateType" : { "type" : "object", "description" : "Minimal climate state information for environmental sensors.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "batteryPercent" : { "type" : "integer", "format" : "int32", "description" : "Battery percentage of the environmental sensor", "example" : 85, "nullable" : true }, "calibrating" : { "type" : "boolean", "description" : "Whether the sensor is currently calibrating", "example" : false, "nullable" : true }, "closestBaseStation" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "co2" : { "type" : "number", "format" : "float", "description" : "CO2 measurement", "example" : 450.0, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Creation timestamp in milliseconds", "example" : 1640995200000, "nullable" : true }, "ethanol" : { "type" : "number", "format" : "float", "description" : "Ethanol measurement", "example" : 5.2, "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version", "example" : "1.2.3", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number", "example" : 2, "nullable" : true }, "health" : { "$ref" : "#/components/schemas/Climate_ClimateHealthEnum" }, "healthDetails" : { "$ref" : "#/components/schemas/Climate_ClimateHealthDetailsEnum" }, "heatIndexDegF" : { "type" : "number", "format" : "double", "description" : "Heat index in degrees Fahrenheit", "example" : 85.2, "nullable" : true }, "heatIndexRangeWarning" : { "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" }, "humidity" : { "type" : "number", "format" : "float", "description" : "Relative humidity percentage", "example" : 45.2, "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "iaq" : { "type" : "number", "format" : "float", "description" : "Indoor Air Quality index", "example" : 85.5, "nullable" : true }, "lastSeenSec" : { "type" : "integer", "format" : "int64", "description" : "Last seen timestamp in seconds", "example" : 1640995200, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the environmental sensor", "example" : "Office Climate Sensor", "nullable" : true }, "pm25" : { "type" : "number", "format" : "float", "description" : "PM2.5 particulate matter measurement", "example" : 12.3, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "probeConnected" : { "type" : "boolean", "description" : "Whether the probe is connected", "example" : true, "nullable" : true }, "probeTempC" : { "type" : "number", "format" : "float", "description" : "Temperature probe measurement in Celsius", "example" : 24.1, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the environmental sensor", "example" : "ES-123456789", "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the environmental sensor", "example" : 85, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "temperatureCelcius" : { "type" : "number", "format" : "float", "description" : "Temperature in Celsius", "example" : 23.5, "nullable" : true }, "thcPercent" : { "type" : "number", "format" : "float", "description" : "THC percentage measurement", "example" : 0.8, "nullable" : true }, "tvoc" : { "type" : "number", "format" : "float", "description" : "Total Volatile Organic Compounds (TVOC) measurement", "example" : 125.5, "nullable" : true }, "vapePercent" : { "type" : "number", "format" : "float", "description" : "Vape percentage measurement", "example" : 2.1, "nullable" : true } } }, "Climate_MinimalEnvironmentalGatewayStateType" : { "type" : "object", "description" : "Minimal environmental gateway state information.", "properties" : { "activities" : { "type" : "array", "description" : "List of detected activities", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "airQualityIndex" : { "type" : "integer", "format" : "int32", "description" : "Air quality index value", "example" : 45, "nullable" : true }, "airQualityIndexPollutant" : { "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" }, "alertTriggers" : { "type" : "array", "description" : "List of alert triggers", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "calibrating" : { "type" : "boolean", "description" : "Whether the gateway is currently calibrating", "example" : false, "nullable" : true }, "ch2oPpb" : { "type" : "number", "format" : "float", "description" : "Formaldehyde measurement in parts per billion", "example" : 15.7, "nullable" : true }, "co2Ppm" : { "type" : "integer", "format" : "int32", "description" : "CO2 measurement in parts per million", "example" : 450, "nullable" : true }, "coConcentration" : { "type" : "number", "format" : "double", "description" : "Carbon monoxide concentration", "example" : 2.1, "nullable" : true }, "connected" : { "type" : "boolean", "description" : "Whether the gateway is connected", "example" : true, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Creation timestamp in milliseconds", "example" : 1640995200000, "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "description" : "Default interface MAC address", "example" : "00:1A:2B:3C:4D:5E", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "externalIPAddress" : { "type" : "string", "description" : "External IP address", "example" : "203.0.113.1", "nullable" : true }, "falsePositiveConfidencePercent" : { "type" : "number", "format" : "float", "description" : "False positive confidence percentage", "example" : 5.2, "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version", "example" : "2.1.5", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number", "example" : 2, "nullable" : true }, "healthDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "heatIndexDegF" : { "type" : "number", "format" : "double", "description" : "Heat index in degrees Fahrenheit", "example" : 85.2, "nullable" : true }, "heatIndexRangeWarning" : { "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "iaq" : { "type" : "number", "format" : "float", "description" : "Indoor Air Quality index", "example" : 85.5, "nullable" : true }, "lanAddresses" : { "type" : "array", "description" : "List of LAN IP addresses", "items" : { "type" : "string", "description" : "List of LAN IP addresses", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate", "example" : 37.7749, "nullable" : true }, "leakDetected" : { "type" : "boolean", "description" : "Whether a leak is detected", "example" : false, "nullable" : true }, "leakProbePresent" : { "type" : "boolean", "description" : "Whether leak probe is present", "example" : true, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the environmental gateway", "example" : "Main Office Gateway", "nullable" : true }, "nc0p5" : { "type" : "number", "format" : "float", "description" : "Number concentration 0.5 measurement", "example" : 120.5, "nullable" : true }, "nc10p0" : { "type" : "number", "format" : "float", "description" : "Number concentration 10.0 measurement", "example" : 15.3, "nullable" : true }, "nc1p0" : { "type" : "number", "format" : "float", "description" : "Number concentration 1.0 measurement", "example" : 85.2, "nullable" : true }, "nc2p5" : { "type" : "number", "format" : "float", "description" : "Number concentration 2.5 measurement", "example" : 45.8, "nullable" : true }, "nc4p0" : { "type" : "number", "format" : "float", "description" : "Number concentration 4.0 measurement", "example" : 32.1, "nullable" : true }, "noxIdx" : { "type" : "number", "format" : "float", "description" : "Nitrogen Oxides index", "example" : 88.2, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pm10p0" : { "type" : "number", "format" : "float", "description" : "PM10.0 particulate matter measurement", "example" : 18.9, "nullable" : true }, "pm1p0" : { "type" : "number", "format" : "float", "description" : "PM1.0 particulate matter measurement", "example" : 8.5, "nullable" : true }, "pm2p5" : { "type" : "number", "format" : "float", "description" : "PM2.5 particulate matter measurement", "example" : 12.3, "nullable" : true }, "pm4p0" : { "type" : "number", "format" : "float", "description" : "PM4.0 particulate matter measurement", "example" : 15.7, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pressure" : { "type" : "number", "format" : "float", "description" : "Pressure measurement", "example" : 1013.25, "nullable" : true }, "probeTempC" : { "type" : "number", "format" : "float", "description" : "Temperature probe measurement in Celsius", "example" : 24.5, "nullable" : true }, "relHumid" : { "type" : "number", "format" : "float", "description" : "Relative humidity percentage", "example" : 45.2, "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the environmental gateway", "example" : "EG-123456789", "nullable" : true }, "smokeConfidencePercent" : { "type" : "number", "format" : "float", "description" : "Smoke detection confidence percentage", "example" : 92.8, "nullable" : true }, "smokeTobaccoConfidencePercent" : { "type" : "number", "format" : "float", "description" : "Smoke tobacco detection confidence percentage", "example" : 88.1, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "tempC" : { "type" : "number", "format" : "float", "description" : "Temperature in Celsius", "example" : 23.5, "nullable" : true }, "tempProbePresent" : { "type" : "boolean", "description" : "Whether temperature probe is present", "example" : true, "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds", "example" : 1640995200000, "nullable" : true }, "typPartSize" : { "type" : "number", "format" : "float", "description" : "Typical particle size measurement", "example" : 2.8, "nullable" : true }, "vapeConfidencePercent" : { "type" : "number", "format" : "float", "description" : "Vape detection confidence percentage", "example" : 85.5, "nullable" : true }, "vapeDetected" : { "type" : "boolean", "description" : "Whether vape is detected", "example" : false, "nullable" : true }, "vapeThcConfidencePercent" : { "type" : "number", "format" : "float", "description" : "Vape THC detection confidence percentage", "example" : 72.3, "nullable" : true }, "vocIdx" : { "type" : "number", "format" : "float", "description" : "Volatile Organic Compounds index", "example" : 125.5, "nullable" : true } } }, "Climate_RebootEnvironmentalGatewayWSRequest" : { "type" : "object", "description" : "Request to reboot an environmental gateway.", "properties" : { "environmentalGatewayUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Climate_UpdateClimateSensorDetailsWSRequest" : { "type" : "object", "description" : "Request to update details for an environmental sensor.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "associatedCamerasUpdated" : { "type" : "boolean", "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the environmental sensor is deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the environmental sensor", "example" : "Temperature and humidity sensor in main office", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the environmental sensor is located", "example" : 1, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the environmental sensor", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the environmental sensor", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the environmental sensor", "example" : "Main Office Sensor", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Climate_UpdateClimateSensorDetailsWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating environmental sensor details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Climate_UpdateEnvironmentalGatewayDetailsWSRequest" : { "type" : "object", "description" : "Request to update details for an environmental gateway.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "associatedCamerasUpdated" : { "type" : "boolean", "description" : "Whether the associated cameras have been updated", "example" : false, "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the environmental gateway is deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "description" : "Whether the deleted status has been updated", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the environmental gateway", "example" : "Environmental monitoring gateway in main office", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "description" : "Whether the description has been updated", "example" : false, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the environmental gateway is located", "example" : 1, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "description" : "Whether the floor number has been updated", "example" : false, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the environmental gateway", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "description" : "Whether the latitude has been updated", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "description" : "Whether the location UUID has been updated", "example" : false, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the environmental gateway", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "description" : "Whether the longitude has been updated", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the environmental gateway", "example" : "Main Office Gateway", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "description" : "Whether the name has been updated", "example" : false, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "description" : "Whether the policy UUID has been updated", "example" : false, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Climate_UpdateEnvironmentalGatewayDetailsWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating environmental gateway details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "ClipAccessSettings" : { "type" : "object", "description" : "Visibility setting for the clip", "properties" : { "allowedRoles" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "allowedUsers" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "visibility" : { "$ref" : "#/components/schemas/ClipVisibilityEnum" } } }, "ClipBoundingBoxType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "alert" : { "type" : "boolean", "nullable" : true }, "bottom" : { "type" : "integer", "format" : "int32", "nullable" : true }, "confidence" : { "type" : "number", "format" : "float", "nullable" : true }, "croppedImageLocator" : { "type" : "string", "nullable" : true }, "customActivityColor" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "customActivityDescription" : { "type" : "string", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "nullable" : true }, "dwelling" : { "type" : "boolean", "nullable" : true }, "faceName" : { "type" : "string", "nullable" : true }, "inMotion" : { "type" : "boolean", "nullable" : true }, "keypointsV2" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PointType" }, "nullable" : true }, "left" : { "type" : "integer", "format" : "int32", "nullable" : true }, "licensePlate" : { "type" : "string", "nullable" : true }, "loudness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "objectId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "pose" : { "type" : "string", "nullable" : true }, "relativeSecond" : { "type" : "number", "format" : "float", "nullable" : true }, "right" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensorValType" : { "$ref" : "#/components/schemas/SensorValType" }, "stableTrackId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "toastOrderIdInfo" : { "$ref" : "#/components/schemas/ToastOrderIdType" }, "top" : { "type" : "integer", "format" : "int32", "nullable" : true }, "unidentifiedFaceId" : { "type" : "string", "nullable" : true }, "vehicleName" : { "type" : "string", "nullable" : true } } }, "ClipDevice" : { "type" : "object", "description" : "A device contributing to a spliced clip.", "nullable" : true, "properties" : { "device" : { "$ref" : "#/components/schemas/TimelineEntryDevice" }, "location" : { "$ref" : "#/components/schemas/TimelineEntryLocation" } } }, "ClipEntryStatusEnum" : { "type" : "string", "description" : "Availability of the clip on a clip timeline entry.", "enum" : [ "PENDING", "READY", "FAILED" ] }, "ClipGroupType" : { "type" : "object", "description" : "List of clip groups for the organization", "properties" : { "clips" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SharedClipV2Type" }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "isShared" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sharedGroups" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ClipGroupWithDetailsType" : { "type" : "object", "description" : "Detailed information about the clip group", "properties" : { "clips" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SharedClipWithDetailsType" }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "isShared" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sharedGroups" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ClipMetaDataType" : { "type" : "object", "properties" : { "activitySeekPoints" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "nullable" : true }, "activitySeekPointsV2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClipSeekPointType" }, "nullable" : true }, "activitySeekPointsV3" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClipSeekPointV2Type" }, "nullable" : true }, "boundingBoxes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClipBoundingBoxType" }, "nullable" : true }, "clipLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "mGrids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "soundSignificantLufs" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "nullable" : true }, "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "thumbnailLocationV2" : { "type" : "string", "nullable" : true } } }, "ClipSeekPointType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "alert" : { "type" : "boolean", "nullable" : true }, "bottom" : { "type" : "number", "format" : "float", "nullable" : true }, "faceName" : { "type" : "string", "nullable" : true }, "keypointsV2" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PointType" }, "nullable" : true }, "left" : { "type" : "number", "format" : "float", "nullable" : true }, "licensePlate" : { "type" : "string", "nullable" : true }, "pose" : { "type" : "string", "nullable" : true }, "relativeSecond" : { "type" : "number", "format" : "float", "nullable" : true }, "right" : { "type" : "number", "format" : "float", "nullable" : true }, "top" : { "type" : "number", "format" : "float", "nullable" : true }, "unidentifiedFaceId" : { "type" : "string", "nullable" : true }, "vehicleName" : { "type" : "string", "nullable" : true } } }, "ClipSeekPointV2Type" : { "type" : "object", "description" : "List of seek points for the clip", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "alert" : { "type" : "boolean", "nullable" : true }, "customActivityColor" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "customActivityDescription" : { "type" : "string", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "nullable" : true }, "dcao" : { "type" : "boolean", "nullable" : true }, "dwelling" : { "type" : "boolean", "nullable" : true }, "faceName" : { "type" : "string", "nullable" : true }, "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inMotion" : { "type" : "boolean", "nullable" : true }, "licensePlate" : { "type" : "string", "nullable" : true }, "loudness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "pose" : { "type" : "string", "nullable" : true }, "relativeSecond" : { "type" : "number", "format" : "float", "nullable" : true }, "sensorValType" : { "$ref" : "#/components/schemas/SensorValType" }, "stableTrackId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "toastOrderIdInfo" : { "$ref" : "#/components/schemas/ToastOrderIdType" }, "tu" : { "type" : "string", "nullable" : true }, "unidentifiedFaceId" : { "type" : "string", "nullable" : true }, "vehicleName" : { "type" : "string", "nullable" : true } } }, "ClipStatusEnum" : { "type" : "string", "enum" : [ "INITIATING", "UPLOADING", "RENDERING", "FAILED", "COMPLETE", "OFFLINE", "DELETED", "UNKNOWN" ] }, "ClipTimelineEntry" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "clipKey" : { "type" : "string", "description" : "Storage key of the copied clip, assigned when the source clip is copied. Caller-supplied value is ignored. Null when the status is not READY or when the entry is redacted.", "nullable" : true }, "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "devices" : { "type" : "array", "description" : "The devices from which the clip was spliced, each with its location when the entry was created.", "items" : { "$ref" : "#/components/schemas/ClipDevice" }, "nullable" : true }, "status" : { "$ref" : "#/components/schemas/ClipEntryStatusEnum" } } } ], "description" : "A timeline entry containing a video clip.", "nullable" : true, "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "imageKey" : { "type" : "string", "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, "location" : { "$ref" : "#/components/schemas/TimelineEntryLocation" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "systemGenerated" : { "type" : "boolean", "description" : "Whether the entry was generated by the system rather than created by a user.", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/TimelineEntryTypeEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ClipVisibilityEnum" : { "type" : "string", "description" : "Use accessSettings instead", "enum" : [ "PRIVATE", "ROLE_RESTRICTED", "ORG_WIDE" ] }, "CloudArchivingStrategyEnum" : { "type" : "string", "enum" : [ "WEEKLY_SCHEDULED", "CONTINUOUS" ] }, "Co2SensorType" : { "type" : "object", "properties" : { "co2Ppm" : { "type" : "integer", "format" : "int32", "nullable" : true }, "relHumid" : { "type" : "number", "format" : "float", "nullable" : true }, "tempC" : { "type" : "number", "format" : "float", "nullable" : true }, "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "ColorEnum" : { "type" : "string", "description" : "Set of colors to filter by", "enum" : [ "BLACK", "BLUE", "BROWN", "GRAYWHITE", "GREEN", "ORANGE", "PINK", "PURPLE", "RED", "YELLOW", "UNKNOWN" ] }, "Common_devices_CalibrateFloorplanProjectionWSRequest" : { "type" : "object", "description" : "Request to calibrate floorplan projection for a device.", "properties" : { "cameraImagePointsPermyriad" : { "type" : "array", "description" : "List of camera image points in permyriad coordinates", "items" : { "type" : "array", "description" : "List of camera image points in permyriad coordinates", "items" : { "type" : "integer", "format" : "int32", "description" : "List of camera image points in permyriad coordinates", "nullable" : true }, "nullable" : true }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "floorplanImagePointsPermyriad" : { "type" : "array", "description" : "List of floorplan image points in permyriad coordinates", "items" : { "type" : "array", "description" : "List of floorplan image points in permyriad coordinates", "items" : { "type" : "integer", "format" : "int32", "description" : "List of floorplan image points in permyriad coordinates", "nullable" : true }, "nullable" : true }, "nullable" : true } } }, "Common_devices_CalibrateFloorplanProjectionWSResponse" : { "type" : "object", "description" : "Response containing the calibrated floorplan projection homography.", "properties" : { "homography" : { "type" : "array", "description" : "3x3 homography matrix for floorplan projection", "items" : { "type" : "array", "description" : "3x3 homography matrix for floorplan projection", "items" : { "type" : "number", "format" : "double", "description" : "3x3 homography matrix for floorplan projection", "nullable" : true }, "nullable" : true }, "nullable" : true } } }, "Common_devices_DeviceUptimeWindowsType" : { "type" : "object", "description" : "Uptime windows for a single device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uptimeWindows" : { "type" : "array", "description" : "List of uptime windows for the device within the requested range", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true } } }, "Common_devices_GetBoundingBoxesWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "durationSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Common_devices_GetBoundingBoxesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageBoundingBoxes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FootageBoundingBoxType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_GetCameraOrDoorbellCameraSeekpointsWSRequest" : { "type" : "object", "properties" : { "activitySet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "durationSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "nullable" : true }, "seekpointDurationIntervalSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Common_devices_GetFullDeviceStateWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "force" : { "type" : "boolean", "nullable" : true } } }, "Common_devices_GetMediaUrisWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Common_devices_GetMinimalDeviceStateListWSRequest" : { "type" : "object", "properties" : { "includeMummified" : { "type" : "boolean", "nullable" : true } } }, "Common_devices_GetPresenceWindowsWSRequest" : { "type" : "object", "description" : "Request to get stored video information for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int64", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true } } }, "Common_devices_GetPresenceWindowsWSResponse" : { "type" : "object", "description" : "Response containing stored video information for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "presenceWindows" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of presence types to their time windows", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "description" : "Map of presence types to their time windows", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_GetSeekpointsWSRequest" : { "type" : "object", "description" : "General seekpoints search request parameters", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "durationSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Common_devices_GetSeekpointsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "footageSeekPoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FootageSeekPointV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_GetUptimeWindowsForOrgWSRequest" : { "type" : "object", "description" : "Request to get uptime windows for many devices in a single call.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "Optional list of device UUIDs to include. When omitted or empty, all devices of the endpoint's type in the organization are included.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds since epoch", "example" : 1643673600000, "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds since epoch", "example" : 1640995200000, "nullable" : true } } }, "Common_devices_GetUptimeWindowsForOrgWSResponse" : { "type" : "object", "description" : "Response containing uptime windows for many devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uptimeByDevice" : { "type" : "array", "description" : "Uptime windows per device", "items" : { "$ref" : "#/components/schemas/Common_devices_DeviceUptimeWindowsType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_GetUptimeWindowsWSRequest" : { "type" : "object", "description" : "Request to get uptime information for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds since epoch", "example" : 1643673600000, "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds since epoch", "example" : 1640995200000, "nullable" : true } } }, "Common_devices_GetUptimeWindowsWSResponse" : { "type" : "object", "description" : "Response containing uptime information for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uptimeWindows" : { "type" : "array", "description" : "List of uptime windows for the device", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_RebootDeviceWSResponse" : { "type" : "object", "description" : "Response indicating the result of rebooting a device.", "properties" : { "result" : { "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse_RebootResult" } } }, "Common_devices_RebootDeviceWSResponse_RebootResult" : { "type" : "string", "description" : "Result of the reboot operation", "enum" : [ "REBOOT_SENT", "DEVICE_OFFLINE" ] }, "Common_devices_UpdateConfigWSResponse" : { "type" : "object", "description" : "Response indicating the result of updating device configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_UpdateDeviceDetailsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_rawstream_CreateRawHttpStreamWSRequest" : { "type" : "object", "description" : "Request to create a raw HTTP stream for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "rawStreamName" : { "type" : "string", "description" : "Name for the raw stream", "example" : "my_raw_stream", "nullable" : true }, "streamType" : { "$ref" : "#/components/schemas/StreamTypeEnum" } } }, "Common_devices_rawstream_CreateRawHttpStreamWSResponse" : { "type" : "object", "description" : "Response containing raw HTTP stream URLs for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lanAudioUrl" : { "type" : "string", "description" : "LAN audio URL for the raw stream", "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/audio", "nullable" : true }, "lanVideoLowResUrl" : { "type" : "string", "description" : "LAN low resolution video URL for the raw stream", "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video_low", "nullable" : true }, "lanVideoUrl" : { "type" : "string", "description" : "LAN video URL for the raw stream", "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_rawstream_DeleteRawHttpStreamWSRequest" : { "type" : "object", "description" : "Request to delete raw HTTP streams for a device.", "properties" : { "customPathPart" : { "type" : "string", "description" : "Custom path part to identify specific stream", "example" : "my_stream", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Common_devices_rawstream_DeleteRawHttpStreamWSResponse" : { "type" : "object", "description" : "Response indicating the result of deleting raw HTTP streams.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" : { "type" : "object", "description" : "Request to retrieve all raw HTTP streams." }, "Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" : { "type" : "object", "description" : "Response containing all raw HTTP streams.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rawHttpStreams" : { "type" : "array", "description" : "List of all raw HTTP streams", "items" : { "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_rawstream_GetRawHttpStreamsWSRequest" : { "type" : "object", "description" : "Request to retrieve raw HTTP streams for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Common_devices_rawstream_GetRawHttpStreamsWSResponse" : { "type" : "object", "description" : "Response containing raw HTTP streams for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rawHttpStreams" : { "type" : "array", "description" : "List of raw HTTP streams", "items" : { "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Common_devices_rawstream_LanSpecificRawStreamType" : { "type" : "object", "description" : "List of raw HTTP streams", "properties" : { "audioPath" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBy" : { "type" : "string", "nullable" : true }, "customPathPart" : { "type" : "string", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "lanAudioUrl" : { "type" : "string", "nullable" : true }, "lanVideoLowResUrl" : { "type" : "string", "nullable" : true }, "lanVideoUrl" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "streamType" : { "$ref" : "#/components/schemas/StreamTypeEnum" }, "videoLowResPath" : { "type" : "string", "nullable" : true }, "videoPath" : { "type" : "string", "nullable" : true } } }, "ComponentBaseEnumType" : { "type" : "string", "enum" : [ "reader", "dpi", "relay", "rex", "aux", "aperio", "schlage", "button" ] }, "ComponentCompositeEnumType" : { "type" : "string", "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] }, "ComponentCompositeEnumType_Minimal" : { "type" : "string", "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] }, "ComponentCompositeEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeName" : { "type" : "string", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, "ComponentCompositeShadowEnum" : { "type" : "string", "enum" : [ "AccessControlledDoorShadow", "AccessControlledElevatorLandingShadow" ] }, "ComponentEnumType" : { "type" : "string", "enum" : [ "RhombusOsdpDoorReader", "OsdpDoorReader", "WiegandDoorReader", "IntegratedDoorPositionIndicator", "IntegratedRequestToExit", "IntegratedDoorRelay", "IntegratedGenericRelay", "IntegratedGenericInput", "IntegratedGenericButton", "SchlageInputButton", "AperioActivatorButton", "AperioGateway", "AperioRs485Gateway", "AperioDoorExtension", "AperioDoorRelay", "AperioDoorPositionIndicator", "AperioDoorReader", "AperioRs485DoorReader", "AperioRs485DoorRelay", "AperioRs485DoorPositionIndicator", "AperioRs485DoorRequestToExit", "AperioRs485DoorExtension", "AperioDoorRequestToExit", "SchlageRs485Gateway", "SchlageRs485DoorExtension", "SchlageRs485DoorRelay", "SchlageRs485DoorPositionIndicator", "SchlageRs485DoorReader", "SchlageRs485DoorRequestToExit" ] }, "ComponentEventEnumType" : { "type" : "string", "description" : "Limits results to only contain the specified type of events, if applicable", "enum" : [ "DoorbellEvent", "DoorReaderStateChangeEvent", "DoorRelayStateChangeEvent", "DoorPositionIndicatorStateChangeEvent", "RequestToExitStateChangeEvent", "CredentialReceivedEvent", "ButtonEvent", "GenericInputStateChangeEvent", "GenericRelayStateChangeEvent", "AccessControlUnitTamperEvent", "AccessControlUnitLocationLockdownStateEvent", "DoorLocationLockdownStateEvent", "PanicButtonEvent", "AccessControlUnitBatteryStateChangeEvent", "WaveToUnlockIntentExpiredEvent", "DoorStateChangeEvent", "DoorAuthFirstInStateEvent", "DoorScheduleFirstInStateEvent", "AccessControlUnitDoorFirstInStateEvent", "AperioDoorExtensionStateEvent", "AperioActivatorStateEvent", "AperioKeyCylinderStateEvent", "AperioDoorModeEvent", "AperioDoorHandleStateEvent", "AperioGatewayStateEvent", "AperioGatewayConnectionStateChangeEvent", "AperioDtcEvent", "AperioTamperStateEvent", "IntercomTalkEvent", "SchlageDoorExtensionStateEvent", "SchlageRs485GatewayStateEvent", "SchlageRs485GatewayConnectionStateChangeEvent" ] }, "ComponentEventType" : { "type" : "object", "description" : "List of component events for the doorbell camera", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/DoorbellEventType" }, { "$ref" : "#/components/schemas/DoorReaderStateChangeEventType" }, { "$ref" : "#/components/schemas/DoorRelayStateChangeEventType" }, { "$ref" : "#/components/schemas/DoorPositionIndicatorStateChangeEventType" }, { "$ref" : "#/components/schemas/RequestToExitStateChangeEventType" }, { "$ref" : "#/components/schemas/CredentialReceivedEventType" }, { "$ref" : "#/components/schemas/ButtonEventType" }, { "$ref" : "#/components/schemas/GenericInputStateChangeEventType" }, { "$ref" : "#/components/schemas/GenericRelayStateChangeEventType" }, { "$ref" : "#/components/schemas/AccessControlUnitTamperEventType" }, { "$ref" : "#/components/schemas/AccessControlUnitLocationLockdownStateEventType" }, { "$ref" : "#/components/schemas/DoorLocationLockdownStateEventType" }, { "$ref" : "#/components/schemas/PanicButtonEventType" }, { "$ref" : "#/components/schemas/AccessControlUnitBatteryStateChangeEventType" }, { "$ref" : "#/components/schemas/WaveToUnlockIntentExpiredEvent" }, { "$ref" : "#/components/schemas/DoorStateChangeEvent" }, { "$ref" : "#/components/schemas/DoorAuthFirstInStateEvent" }, { "$ref" : "#/components/schemas/DoorScheduleFirstInStateEvent" }, { "$ref" : "#/components/schemas/AccessControlUnitDoorFirstInStateEvent" }, { "$ref" : "#/components/schemas/AperioDtcEvent" }, { "$ref" : "#/components/schemas/AperioDoorExtensionStateEvent" }, { "$ref" : "#/components/schemas/AperioActivatorStateEvent" }, { "$ref" : "#/components/schemas/AperioDoorModeEvent" }, { "$ref" : "#/components/schemas/AperioDoorHandleStateEvent" }, { "$ref" : "#/components/schemas/AperioKeyCylinderStateEvent" }, { "$ref" : "#/components/schemas/IntercomTalkEventType" }, { "$ref" : "#/components/schemas/SchlageDoorExtensionStateEvent" } ], "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ComponentReferenceType" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ComponentReferenceType_Minimal" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ComponentRelayOutputTypeEnum" : { "type" : "string", "enum" : [ "TRANSIENT", "STEADY" ] }, "ComponentSeekPointType" : { "type" : "object", "description" : "List of component seekpoints for the doorbell camera", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "customActivityColor" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "customActivityDescription" : { "type" : "string", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originalEvent" : { "type" : "object", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ComponentShadowEnumType" : { "type" : "string", "enum" : [ "DoorReaderShadow", "DoorRelayShadow", "DoorPositionIndicatorShadow", "RequestToExitShadow", "GenericRelayShadow", "GenericInputShadow", "GenericButtonShadow", "AperioGatewayShadow", "AperioDoorExtensionShadow", "SchlageGatewayShadow", "SchlageDoorExtensionShadow" ] }, "ComponentShadowType" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/DoorReaderShadowType" }, { "$ref" : "#/components/schemas/DoorRelayShadowType" }, { "$ref" : "#/components/schemas/DoorPositionIndicatorShadowType" }, { "$ref" : "#/components/schemas/RequestToExitShadowType" }, { "$ref" : "#/components/schemas/GenericInputShadowType" }, { "$ref" : "#/components/schemas/IntegratedDoorRelayType" }, { "$ref" : "#/components/schemas/GenericRelayShadowType" }, { "$ref" : "#/components/schemas/GenericButtonShadowType" }, { "$ref" : "#/components/schemas/AperioGatewayShadow" }, { "$ref" : "#/components/schemas/AperioDoorExtensionShadow" }, { "$ref" : "#/components/schemas/SchlageGatewayShadow" }, { "$ref" : "#/components/schemas/SchlageDoorExtensionShadow" } ], "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_AddAccessControlledDoorLabelWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "nullable" : true } } }, "Component_AddAccessControlledDoorLabelWSResponse" : { "type" : "object" }, "Component_AddAccessControlledElevatorLandingLabelWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "nullable" : true } } }, "Component_AddAccessControlledElevatorLandingLabelWSResponse" : { "type" : "object" }, "Component_AggregatedCredentialReceivedEventInfo" : { "type" : "object", "properties" : { "firstEvent" : { "$ref" : "#/components/schemas/CredentialReceivedEventType" }, "lastEvent" : { "$ref" : "#/components/schemas/CredentialReceivedEventType" }, "totalCount" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_ApplyAccessControlledDoorStateOverrideWSRequest" : { "type" : "object", "description" : "Door state overrides are temporary changes to door's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorAuthFirstInState" : { "$ref" : "#/components/schemas/FirstInStatusEnum" }, "doorScheduleFirstInState" : { "$ref" : "#/components/schemas/FirstInStatusEnum" }, "expireEarlyMode" : { "$ref" : "#/components/schemas/EarlyExpireModeEnum" }, "expiresAtMillis" : { "type" : "integer", "format" : "int64", "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", "nullable" : true }, "followFirstInRules" : { "type" : "boolean", "description" : "Default is false if not specified, the door state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, "startDelaySeconds" : { "type" : "integer", "format" : "int64", "description" : "Default is 0 if not specified, determines how long to wait before applying the override", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } }, "required" : [ "accessControlledDoorUuid", "state" ] }, "Component_ApplyAccessControlledDoorStateOverrideWSResponse" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" } } }, "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { "type" : "object", "description" : "Elevator landing state overrides are temporary changes to landings's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "accessScheduleFirstInState" : { "$ref" : "#/components/schemas/FirstInStatusEnum" }, "authFirstInState" : { "$ref" : "#/components/schemas/FirstInStatusEnum" }, "expireEarlyMode" : { "$ref" : "#/components/schemas/EarlyExpireModeEnum" }, "expiresAtMillis" : { "type" : "integer", "format" : "int64", "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", "nullable" : true }, "followFirstInRules" : { "type" : "boolean", "description" : "Default is false if not specified, the elevator landing state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, "startDelaySeconds" : { "type" : "integer", "format" : "int64", "description" : "Default is 0 if not specified, determines how long to wait before applying the override", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } }, "required" : [ "accessControlledElevatorLandingUuid", "state" ] }, "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" } } }, "Component_CancelAccessControlledDoorStateOverrideWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "accessControlledDoorUuid" ] }, "Component_CancelAccessControlledDoorStateOverrideWSResponse" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" } } }, "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "accessControlledElevatorLandingUuid" ] }, "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" } } }, "Component_CreateAccessControlledDoorSeekpointsWSRequest" : { "type" : "object", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "seekPoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomFootageSeekPointType" }, "nullable" : true } } }, "Component_CreateAccessControlledDoorSeekpointsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "successMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "accessControlledDoorLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Component_CreateAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAccessControlledElevatorLandingWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, "accessControlledElevatorLandingLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Component_CreateAccessControlledElevatorLandingWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAccessControlledElevatorWSRequest" : { "type" : "object", "properties" : { "accessControlledElevator" : { "$ref" : "#/components/schemas/AccessControlledElevator" } } }, "Component_CreateAccessControlledElevatorWSResponse" : { "type" : "object", "nullable" : true, "properties" : { "accessControlledElevator" : { "$ref" : "#/components/schemas/AccessControlledElevator" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAperioDoorInfo" : { "type" : "object", "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", "properties" : { "aperioDoorDeviceId" : { "type" : "string", "nullable" : true }, "aperioDoorId" : { "type" : "string", "nullable" : true } } }, "Component_CreateAperioDoorsWSRequest" : { "type" : "object", "properties" : { "aperioGatewayComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doors" : { "type" : "array", "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", "items" : { "$ref" : "#/components/schemas/Component_CreateAperioDoorInfo" }, "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioGatewayComponentId", "doors", "ownerDeviceUuid" ] }, "Component_CreateAperioDoorsWSResponse" : { "type" : "object", "properties" : { "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAperioGatewayWSRequest" : { "type" : "object", "properties" : { "aperioGatewayId" : { "type" : "string", "description" : "The Aperio-assigned ID of the gateway, given as a hex string, e.g. \"034AB5\".", "nullable" : true }, "includeAperioDoors" : { "type" : "boolean", "default" : false, "description" : "If enabled, also creates Aperio doors with this request.", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioGatewayId", "ownerDeviceUuid" ] }, "Component_CreateAperioGatewayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/AperioGateway" }, "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAperioRs485DoorInfo" : { "type" : "object", "description" : "Where each lock sits on the hub's line, and what kind of lock it is.", "properties" : { "eacAddress" : { "type" : "integer", "format" : "int32", "description" : "Where the lock answers on its hub's RS-485 line, 0x01 to 0xFF. The hub's base address comes from its DIP switches and its locks are addressed from there: a hub based at 0x01 has locks at 0x01, 0x11, 0x21 and so on.", "example" : 17, "nullable" : true }, "model" : { "$ref" : "#/components/schemas/AperioLockModelEnum" } }, "required" : [ "eacAddress" ] }, "Component_CreateAperioRs485DoorsWSRequest" : { "type" : "object", "properties" : { "aperioGatewayComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doors" : { "type" : "array", "description" : "Where each lock sits on the hub's line, and what kind of lock it is.", "items" : { "$ref" : "#/components/schemas/Component_CreateAperioRs485DoorInfo" }, "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioGatewayComponentId", "doors", "ownerDeviceUuid" ] }, "Component_CreateAperioRs485DoorsWSResponse" : { "type" : "object", "properties" : { "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_FailedRs485Door" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateAperioRs485GatewayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/AperioRs485Gateway" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateIntegratedDoorPositionIndicatorWSRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" } } }, "Component_CreateIntegratedDoorPositionIndicatorWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" } } }, "Component_CreateIntegratedDoorRelayWSRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/DoorRelayPortType" } } }, "Component_CreateIntegratedDoorRelayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedDoorRelayType" } } }, "Component_CreateIntegratedGenericButtonWSRequest" : { "type" : "object", "properties" : { "mode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "name" : { "type" : "string", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/ButtonPortType" } } }, "Component_CreateIntegratedGenericButtonWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericButtonType" } } }, "Component_CreateIntegratedGenericInputWSRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/AuxiliaryInputPortType" } } }, "Component_CreateIntegratedGenericInputWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericInputType" } } }, "Component_CreateIntegratedGenericRelayWSRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/AuxiliaryRelayPortType" }, "steadyState" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" } } }, "Component_CreateIntegratedGenericRelayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, "Component_CreateIntegratedRequestToExitWSRequest" : { "type" : "object", "properties" : { "intentOnly" : { "type" : "boolean", "nullable" : true }, "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/RequestToExitPortType" } } }, "Component_CreateIntegratedRequestToExitWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedRequestToExitType" } } }, "Component_CreateOsdpReaderWSRequest" : { "type" : "object", "properties" : { "allowUnencrypted" : { "type" : "boolean", "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/OsdpReaderPortType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } }, "Component_CreateOsdpReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/OsdpDoorReaderType" } } }, "Component_CreateRhombusOsdpReaderWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableWaveToUnlock" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/OsdpReaderPortType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } }, "Component_CreateRhombusOsdpReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" } } }, "Component_CreateSchlageRs485DoorInfo" : { "type" : "object", "description" : "Where each lock sits on the gateway's line, and which family of lock it is.", "properties" : { "apmFamily" : { "$ref" : "#/components/schemas/SchlageApmFamilyEnum" }, "rs485Address" : { "type" : "integer", "format" : "int32", "description" : "The lock's APM address on its gateway's RS-485 line, 0x00 to 0xFE. 0xAA is the broadcast address and never names a lock.", "example" : 18, "nullable" : true } }, "required" : [ "rs485Address" ] }, "Component_CreateSchlageRs485DoorsWSRequest" : { "type" : "object", "properties" : { "doors" : { "type" : "array", "description" : "Where each lock sits on the gateway's line, and which family of lock it is.", "items" : { "$ref" : "#/components/schemas/Component_CreateSchlageRs485DoorInfo" }, "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "schlageGatewayComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "doors", "ownerDeviceUuid", "schlageGatewayComponentId" ] }, "Component_CreateSchlageRs485DoorsWSResponse" : { "type" : "object", "properties" : { "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_FailedRs485Door" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateSchlageRs485GatewayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/SchlageRs485Gateway" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_CreateWiegandReaderWSRequest" : { "type" : "object", "properties" : { "buzzerPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "csnEndian" : { "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" }, "d0Port" : { "$ref" : "#/components/schemas/WiegandDataPortType" }, "d1Port" : { "$ref" : "#/components/schemas/WiegandDataPortType" }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "gledPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "rledPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "tamperPort" : { "$ref" : "#/components/schemas/WiegandInputPortType" } } }, "Component_CreateWiegandReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/WiegandDoorReaderType" } } }, "Component_DeleteAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_DeleteAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" } } }, "Component_DeleteAccessControlledElevatorLandingWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_DeleteAccessControlledElevatorLandingWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" } } }, "Component_DeleteAccessControlledElevatorWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_DeleteAccessControlledElevatorWSResponse" : { "type" : "object", "nullable" : true, "properties" : { "accessControlledElevator" : { "$ref" : "#/components/schemas/AccessControlledElevator" } } }, "Component_DeleteComponentWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_DeleteComponentWSResponse" : { "type" : "object" }, "Component_DeleteComponentsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_DeleteComponentsByOwnerDeviceWSResponse" : { "type" : "object" }, "Component_FailedRs485Door" : { "type" : "object", "properties" : { "address" : { "type" : "integer", "format" : "int32", "description" : "The address the caller asked for, so the failure can be matched to a row. The EAC address for Aperio, the APM address for Schlage.", "nullable" : true }, "door" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "error" : { "type" : "string", "description" : "Failure message", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/OpStatusEnum" } } }, "Component_FindAccessControlledDoorShadowsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledDoorShadowsByLocationWSResponse" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "shadows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorShadow" }, "nullable" : true } } }, "Component_FindAccessControlledDoorShadowsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledDoorShadowsWSResponse" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "shadows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorShadow" }, "nullable" : true } } }, "Component_FindAccessControlledDoorsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledDoorsByLocationWSResponse" : { "type" : "object", "properties" : { "accessControlledDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAccessControlledDoorsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindAccessControlledDoorsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "accessControlledDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true } } }, "Component_FindAccessControlledDoorsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledDoorsWSResponse" : { "type" : "object", "properties" : { "accessControlledDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingShadowsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingShadowsByLocationWSResponse" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "shadows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" }, "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingShadowsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingShadowsWSResponse" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "shadows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" }, "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingsByLocationWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLandings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorLandingsWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLandings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAccessControlledElevatorsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorsByLocationWSResponse" : { "type" : "object", "properties" : { "accessControlledElevators" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevator" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAccessControlledElevatorsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindAccessControlledElevatorsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "accessControlledElevators" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevator" }, "nullable" : true } } }, "Component_FindAccessControlledElevatorsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindAccessControlledElevatorsWSResponse" : { "type" : "object", "properties" : { "accessControlledElevators" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlledElevator" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindAllComponentShadowsWSRequest" : { "type" : "object", "properties" : { "componentUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Component_FindAllComponentShadowsWSResponse" : { "type" : "object", "properties" : { "acuComponentShadowMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ComponentShadowType" }, "nullable" : true } } }, "Component_FindComponentEventsByAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_FindComponentEventsByAccessControlledElevatorWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByAccessControlledElevatorWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_FindComponentEventsByApiTokenWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByApiTokenWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByComponentWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByComponentWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByCorrelationWSRequest" : { "type" : "object", "properties" : { "correlationId" : { "type" : "string", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByCorrelationWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialHexValueWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "credentialHexValue" : { "type" : "string", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialHexValueWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialUuidWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialUuidWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialValueWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "credentialValue" : { "type" : "string", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByCredentialValueWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByGuestPassWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByGuestPassWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByLocationWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByLocationWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsBySupportAuthorityWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "supportAuthorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsBySupportAuthorityWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsByUserWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindComponentEventsByUserWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsForCurrentUserWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, "Component_FindComponentEventsForCurrentUserWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsForOrgDashboardWSRequest" : { "type" : "object", "properties" : { "componentCompositeFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "reverseSearch" : { "type" : "boolean", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindComponentEventsForOrgDashboardWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true } } }, "Component_FindComponentEventsForVideoIntercomWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "videoIntercomUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindComponentEventsForVideoIntercomWSResponse" : { "type" : "object", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" : { "type" : "object", "description" : "Component seekpoints search for access controlled door", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_FindComponentSeekPointsByAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" : { "type" : "object", "description" : "Component seekpoints search for access controlled doors", "properties" : { "accessControlledDoorUuidList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sortResponse" : { "type" : "boolean", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_FindComponentSeekPointsByAccessControlledDoorsWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentSeekPointsByComponentWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_FindComponentSeekPointsByComponentWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentSeekPointsByLocationWSRequest" : { "type" : "object", "properties" : { "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_FindComponentSeekPointsByLocationWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentSeekPointsByOwnerDeviceWSRequest" : { "type" : "object", "description" : "Component seekpoints search for owner device", "properties" : { "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Component_FindComponentSeekPointsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentSeekPointsByUserWSRequest" : { "type" : "object", "properties" : { "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindComponentSeekPointsByUserWSResponse" : { "type" : "object", "properties" : { "seekpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true } } }, "Component_FindComponentShadowsByComponentCompositesWSRequest" : { "type" : "object", "properties" : { "componentCompositeUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Component_FindComponentShadowsByComponentCompositesWSResponse" : { "type" : "object", "properties" : { "componentShadowMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ComponentShadowType" }, "nullable" : true } } }, "Component_FindComponentShadowsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindComponentShadowsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "componentShadows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentShadowType" }, "nullable" : true } } }, "Component_FindComponentsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_FindComponentsByOwnerDeviceWSResponse" : { "type" : "object", "properties" : { "components" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseComponentType" }, "nullable" : true } } }, "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "activityFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "credSourceFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "nullable" : true }, "originatorTypeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventOriginatorEnum" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "events" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" }, "nullable" : true } } }, "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSRequest" : { "type" : "object", "properties" : { "activityFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "componentCompositeFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "credSourceFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originatorTypeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventOriginatorEnum" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSResponse" : { "type" : "object", "properties" : { "events" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" }, "nullable" : true } } }, "Component_FindMinimalStateAccessControlledDoorsByLocationWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindMinimalStateAccessControlledDoorsByLocationWSResponse" : { "type" : "object", "properties" : { "accessControlledDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindMinimalStateAccessControlledDoorsWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_FindMinimalStateAccessControlledDoorsWSResponse" : { "type" : "object", "properties" : { "accessControlledDoors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_FindPaginatedComponentEventsByAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "reverseSearch" : { "type" : "boolean", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindPaginatedComponentEventsByAccessControlledDoorWSResponse" : { "type" : "object", "description" : "Request object for getting list of component events for the specified door with pagination support.", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_FindPaginatedComponentEventsByOwnerDeviceWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reverseSearch" : { "type" : "boolean", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindPaginatedComponentEventsByOwnerDeviceWSResponse" : { "type" : "object", "description" : "Response object for getting list of component events for the specified owner device with pagination support.", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_FindPaginatedComponentEventsWSRequest" : { "type" : "object", "description" : "Request object for getting list of component events in organization with pagination support.", "properties" : { "componentCompositeFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "reverseSearch" : { "type" : "boolean", "nullable" : true }, "typeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true }, "userFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Component_FindPaginatedComponentEventsWSResponse" : { "type" : "object", "description" : "Request object for getting list of component events in organization with pagination support.", "properties" : { "componentEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, "Component_GetAccessControlledDoorLabelsForOrgWSRequest" : { "type" : "object" }, "Component_GetAccessControlledDoorLabelsForOrgWSResponse" : { "type" : "object", "properties" : { "accessControlledDoorLabels" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "nullable" : true } } }, "Component_GetAccessControlledElevatorLandingLabelsForOrgWSRequest" : { "type" : "object" }, "Component_GetAccessControlledElevatorLandingLabelsForOrgWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLandingLabels" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "nullable" : true } } }, "Component_GetCurrentExpectedAccessControlledComponentCompositeAccessStateWSRequest" : { "type" : "object", "description" : "Determines the expected access state based on the current time and configuration", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "componentCompositeUuid" ] }, "Component_GetCurrentExpectedAccessControlledComponentCompositeAccessStateWSResponse" : { "type" : "object", "properties" : { "current" : { "$ref" : "#/components/schemas/AccessStateBlock" }, "firstInRequirementEnabled" : { "type" : "boolean", "nullable" : true }, "nextStateChange" : { "$ref" : "#/components/schemas/AccessStateChange" }, "upcomingSourceChanges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessStateChange" }, "nullable" : true } } }, "Component_GetCurrentExpectedAccessControlledDoorStateWSRequest" : { "type" : "object", "description" : "Determines the expected door state based on the current time and current door configuration", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "accessControlledDoorUuid" ] }, "Component_GetCurrentExpectedAccessControlledDoorStateWSResponse" : { "type" : "object", "properties" : { "activeDoorState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "activeDoorStateSource" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "defaultDoorStateSource" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "defaultState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "doorStateIfFirstInRequired" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "doorStateIfFirstInSatisfied" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "doorStateSourceIfFirstInRequired" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "doorStateSourceIfFirstInSatisfied" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "firstInRequirementEnabled" : { "type" : "boolean", "nullable" : true }, "firstInRequirementSatisfied" : { "type" : "boolean", "nullable" : true }, "nextNearestSchedule" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" } } }, "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSRequest" : { "type" : "object", "description" : "Determines the expected access state based on the current time and current elevator landing configuration", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "accessControlledElevatorLandingUuid" ] }, "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSResponse" : { "type" : "object", "properties" : { "accessStateIfFirstInRequired" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "accessStateIfFirstInSatisfied" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "accessStateSourceIfFirstInRequired" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "accessStateSourceIfFirstInSatisfied" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "activeAccessState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "activeAccessStateSource" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "defaultDoorStateSource" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, "defaultState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "firstInRequirementEnabled" : { "type" : "boolean", "nullable" : true }, "firstInRequirementSatisfied" : { "type" : "boolean", "nullable" : true }, "nextNearestSchedule" : { "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" } } }, "Component_GetFullAccessControlledDoorShadowWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_GetFullAccessControlledDoorShadowWSResponse" : { "type" : "object", "properties" : { "doorComponentShadowMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ComponentShadowType" }, "nullable" : true }, "doorShadow" : { "$ref" : "#/components/schemas/AccessControlledDoorShadow" } } }, "Component_GetOrCreateDevicePhysicalPortConfigWSRequest" : { "type" : "object", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Component_GetOrCreateDevicePhysicalPortConfigWSResponse" : { "type" : "object", "properties" : { "detectedInvalidPortConfigs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InvalidPhysicalPortConfigType" }, "nullable" : true }, "deviceComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseComponentType" }, "nullable" : true }, "devicePhysicalPortConfig" : { "$ref" : "#/components/schemas/DevicePhysicalPortConfigType" }, "supportedAperioLockModels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AperioLockModelEnum" }, "nullable" : true }, "supportedSchlageApmFamilies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SchlageApmFamilyEnum" }, "nullable" : true } } }, "Component_MinimalStateAccessControlledDoor" : { "type" : "object", "properties" : { "door" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "shadow" : { "$ref" : "#/components/schemas/AccessControlledDoorShadow" } } }, "Component_RemoveAccessControlledDoorLabelWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "nullable" : true } } }, "Component_RemoveAccessControlledDoorLabelWSResponse" : { "type" : "object" }, "Component_RemoveAccessControlledElevatorLandingLabelWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "nullable" : true } } }, "Component_RemoveAccessControlledElevatorLandingLabelWSResponse" : { "type" : "object" }, "Component_UpdateAccessControlledDoorWSRequest" : { "type" : "object", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ajarTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "doorStateToScheduleUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "dpiComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forcedOpenEnabled" : { "type" : "boolean", "nullable" : true }, "forcedOpenTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "relayComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "relockAfterOpenTimeMs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "rexComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "nullable" : true }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "unlockTimeSecRex" : { "type" : "integer", "format" : "int32", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, "Component_UpdateAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { "accessControlledDoor" : { "$ref" : "#/components/schemas/AccessControlledDoorType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_UpdateAccessControlledElevatorLandingWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "accessStateToScheduleUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAccessState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true } } }, "Component_UpdateAccessControlledElevatorLandingWSResponse" : { "type" : "object", "properties" : { "accessControlledElevatorLanding" : { "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_UpdateAccessControlledElevatorWSRequest" : { "type" : "object", "properties" : { "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "associatedFaceDetectionCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "elevatorLandingReferenceUpdates" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ElevatorLandingReference" }, "nullable" : true }, "elevatorLandingReferences" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ElevatorLandingReference" }, "nullable" : true }, "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, "geofenceRadius" : { "type" : "number", "format" : "double", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "proximityUnlockSettings" : { "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, "readerComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true }, "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "waveToUnlockSettings" : { "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, "Component_UpdateAccessControlledElevatorWSResponse" : { "type" : "object", "properties" : { "accessControlledElevator" : { "$ref" : "#/components/schemas/AccessControlledElevator" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Component_UpdateIntegratedDoorPositionIndicatorWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "port" : { "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" } } }, "Component_UpdateIntegratedDoorPositionIndicatorWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" } } }, "Component_UpdateIntegratedDoorRelayWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/DoorRelayPortType" } } }, "Component_UpdateIntegratedDoorRelayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedDoorRelayType" } } }, "Component_UpdateIntegratedGenericButtonWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "name" : { "type" : "string", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/ButtonPortType" } } }, "Component_UpdateIntegratedGenericButtonWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericButtonType" } } }, "Component_UpdateIntegratedGenericInputWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "port" : { "$ref" : "#/components/schemas/AuxiliaryInputPortType" } } }, "Component_UpdateIntegratedGenericInputWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericInputType" } } }, "Component_UpdateIntegratedGenericRelaySteadyStateWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "steadyState" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" } } }, "Component_UpdateIntegratedGenericRelaySteadyStateWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, "Component_UpdateIntegratedGenericRelayTransientStateWSRequest" : { "type" : "object", "properties" : { "activate" : { "type" : "boolean", "nullable" : true }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "durationMs" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Component_UpdateIntegratedGenericRelayTransientStateWSResponse" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "nullable" : true } } }, "Component_UpdateIntegratedGenericRelayWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/AuxiliaryRelayPortType" } } }, "Component_UpdateIntegratedGenericRelayWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, "Component_UpdateIntegratedRequestToExitWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "intentOnly" : { "type" : "boolean", "nullable" : true }, "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "port" : { "$ref" : "#/components/schemas/RequestToExitPortType" } } }, "Component_UpdateIntegratedRequestToExitWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/IntegratedRequestToExitType" } } }, "Component_UpdateOsdpReaderWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/OsdpReaderPortType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } }, "Component_UpdateOsdpReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/OsdpDoorReaderType" } } }, "Component_UpdateRhombusOsdpReaderWSRequest" : { "type" : "object", "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableWaveToUnlock" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "port" : { "$ref" : "#/components/schemas/OsdpReaderPortType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true } } }, "Component_UpdateRhombusOsdpReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" } } }, "Component_UpdateWiegandReaderWSRequest" : { "type" : "object", "properties" : { "buzzerPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "csnEndian" : { "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" }, "d0Port" : { "$ref" : "#/components/schemas/WiegandDataPortType" }, "d1Port" : { "$ref" : "#/components/schemas/WiegandDataPortType" }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "gledPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "name" : { "type" : "string", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "rledPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, "tamperPort" : { "$ref" : "#/components/schemas/WiegandInputPortType" } } }, "Component_UpdateWiegandReaderWSResponse" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/WiegandDoorReaderType" } } }, "ConnectAudioDeviceToMobileAppActionType" : { "type" : "object", "properties" : { "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "targetDoorStationUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "targetUserUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "ConnectAudioDeviceToPhoneNumberActionType" : { "type" : "object", "properties" : { "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "optionalGreeting" : { "type" : "string", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true } } }, "ConnectionStatusEnum" : { "type" : "string", "enum" : [ "ONLINE", "OFFLINE", "UNKNOWN" ] }, "ConnectivityStatus" : { "type" : "string", "description" : "Current connection status of the shared camera", "enum" : [ "GREEN", "RED" ] }, "Consignee" : { "type" : "object", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "address3" : { "type" : "string", "nullable" : true }, "city" : { "type" : "string", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "contactName" : { "type" : "string", "nullable" : true }, "country" : { "type" : "string", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "state" : { "type" : "string", "nullable" : true } } }, "ContentDisposition" : { "type" : "object", "properties" : { "attachment" : { "type" : "boolean", "nullable" : true }, "charset" : { "type" : "object", "nullable" : true, "properties" : { "registered" : { "type" : "boolean", "nullable" : true } } }, "creationDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "filename" : { "type" : "string", "nullable" : true }, "formData" : { "type" : "boolean", "nullable" : true }, "inline" : { "type" : "boolean", "nullable" : true }, "modificationDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "readDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "size" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "type" : "string", "nullable" : true } } }, "ContextRecord" : { "type" : "object", "properties" : { "attributedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "automated" : { "type" : "boolean", "nullable" : true }, "contextId" : { "type" : "string", "nullable" : true }, "expiresAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "queriedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "requestedBy" : { "$ref" : "#/components/schemas/RequestedBy" } } }, "ContextRecordSelectiveUpdate" : { "type" : "object", "properties" : { "realTarget" : { "$ref" : "#/components/schemas/ContextRecord" }, "updatedFieldNameMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "CountingActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "countingThreshold" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "CreateAlarmActionRecordType" : { "type" : "object", "properties" : { "alarmId" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "outcome" : { "type" : "string", "nullable" : true }, "succeeded" : { "type" : "boolean", "nullable" : true }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "CreateAlarmActionType" : { "type" : "object", "properties" : { "attachMediaToActiveAlarm" : { "type" : "boolean", "nullable" : true }, "entryInstructions" : { "type" : "string", "nullable" : true }, "exclusiveEmergencyContact" : { "type" : "boolean", "nullable" : true }, "exclusiveEntryInstructions" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mediaDeviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "onsiteEmergencyContact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "reason" : { "type" : "string", "nullable" : true }, "sirenSettings" : { "$ref" : "#/components/schemas/AMSirenSettingsType" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "triggerType" : { "$ref" : "#/components/schemas/CreateAlarmTriggerTypeEnum" } } }, "CreateAlarmTriggerTypeEnum" : { "type" : "string", "enum" : [ "PANIC_BUTTON", "ALARM_INTEGRATION" ] }, "CreateCoOccurrenceRuleRequest" : { "type" : "object", "properties" : { "orgUuid" : { "type" : "string", "nullable" : true }, "rule" : { "$ref" : "#/components/schemas/IntelliGuardCoOccurrenceRule" } } }, "CreateCoOccurrenceRuleResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "nullable" : true } } }, "CreateTailgatingRuleResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "nullable" : true } } }, "CredentialCapabilityEnum" : { "type" : "string", "enum" : [ "MULTI_FACTOR_AUTH", "PASSWORDLESS", "USERNAMELESS" ] }, "CredentialEntry" : { "type" : "object", "discriminator" : { "propertyName" : "credSource" }, "nullable" : true, "oneOf" : [ { "$ref" : "#/components/schemas/CredentialEntryBleWave" } ], "properties" : { "credSource" : { "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "credentialId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firstInEligible" : { "type" : "boolean", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" } } }, "CredentialEntryBleWave" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "finalRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "firstRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "firstRssiAtIntentElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lostAtIntentElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lostAtRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "maxRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "maxRssiAtIntentElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionFirstRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionFirstRssiAtElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionLostAtElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionLostAtRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionMaxRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sessionMaxRssiAtElapsed" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "credSource" : { "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "credentialId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firstInEligible" : { "type" : "boolean", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" } } }, "CredentialQueryFilter" : { "type" : "object", "description" : "Filter criteria for finding credential history", "properties" : { "credTypeFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "nullable" : true, "uniqueItems" : true }, "lastUsedAccessControlledDoorUuidFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "lastUsedAfterFilter" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedBeforeFilter" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedLocationUuidFilter" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "workflowStatusFilter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" }, "nullable" : true, "uniqueItems" : true } } }, "CredentialReceivedEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "accessGrantOrRevocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "activeDoorLockdownState" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "activeLockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "appName" : { "type" : "string", "nullable" : true }, "appOS" : { "type" : "string", "nullable" : true }, "appVersion" : { "type" : "string", "nullable" : true }, "authDecisionSource" : { "$ref" : "#/components/schemas/AuthDecisionSourceEnum" }, "authDecisionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "authWaitTimeMs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "authWaitTimeMsTotal" : { "type" : "integer", "format" : "int64", "nullable" : true }, "authenticationResult" : { "$ref" : "#/components/schemas/AccessControlAuthenticationResultEnumType" }, "authorizationResult" : { "$ref" : "#/components/schemas/AccessControlAuthorizationResultEnumType" }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "credSource" : { "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "credentialHexValue" : { "type" : "string", "nullable" : true }, "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "credentialValue" : { "type" : "string", "nullable" : true }, "credentialValueLengthBits" : { "type" : "integer", "format" : "int32", "nullable" : true }, "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialEntry" }, "nullable" : true }, "deviceModel" : { "type" : "string", "nullable" : true }, "managedCredentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "satisfiesFirstInSettingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userAgent" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "CredentialSourceEnumType" : { "type" : "string", "enum" : [ "UNKNOWN", "NFC", "BLE_WAVE", "BLE", "WIEGAND", "REMOTE", "REMOTE_ADMIN", "UNK_3P_OSDP", "APERIO_NFC", "APERIO_LF", "APERIO_KEYPAD", "SCHLAGE_NFC", "SCHLAGE_LF", "SCHLAGE_KEYPAD", "KEYPAD_WIEGAND", "KEYPAD_OSDP", "BLE_PROX", "QR_CODE" ] }, "CroppedPermyriadRect" : { "type" : "object", "properties" : { "height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "width" : { "type" : "integer", "format" : "int32", "nullable" : true }, "x" : { "type" : "integer", "format" : "int32", "nullable" : true }, "y" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CrossingCountsType" : { "type" : "object", "description" : "List of crossing counts", "properties" : { "egressCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ingressCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "CrossingDirectionEnum" : { "type" : "string", "enum" : [ "INGRESS", "EGRESS" ] }, "CrossingObjectEnum" : { "type" : "string", "enum" : [ "HUMAN", "VEHICLE", "FACE", "LPR", "POSE", "CLIP_EMBED", "UNKNOWN" ] }, "CustomCredential" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "bitGroupValues" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "customFormatName" : { "type" : "string", "nullable" : true }, "format" : { "$ref" : "#/components/schemas/WiegandFormatEnumType" }, "naturalId" : { "type" : "string", "nullable" : true }, "numBits" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "assigneeType" : { "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" }, "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedAccessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUsedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastUsedLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lowercaseHexValue" : { "type" : "string", "nullable" : true, "readOnly" : true }, "managedCredUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "value" : { "type" : "string", "nullable" : true }, "workflowStatus" : { "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, "CustomFootageSeekPointType" : { "type" : "object", "description" : "List of custom footage seek points to create", "properties" : { "color" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "description" : { "type" : "string", "description" : "Custom activity display description, maximum 100 characters", "maxLength" : 100, "nullable" : true }, "displayOverlay" : { "type" : "boolean", "description" : "Whether to display this seekpoint as an overlay in Console", "nullable" : true }, "name" : { "type" : "string", "description" : "Custom activity display name, maximum 32 characters", "maxLength" : 32, "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "UNIX MS timestamp", "minimum" : 0, "nullable" : true } }, "required" : [ "name", "timestampMs" ] }, "CustomImageElement" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "width" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, "x" : { "type" : "integer", "format" : "int32", "nullable" : true }, "y" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CustomLLMActionType" : { "type" : "object", "properties" : { "deviceActivityEvents" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEventData" }, "nullable" : true }, "nullable" : true }, "deviceFacetUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "CustomLLMEventRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deviceFacetUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "CustomRuleAction" : { "type" : "object", "properties" : { "headers" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "path" : { "type" : "string", "nullable" : true } } }, "CustomTextElement" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "color" : { "type" : "string", "nullable" : true }, "content" : { "type" : "string", "nullable" : true }, "maxWidth" : { "type" : "integer", "format" : "int32", "nullable" : true }, "style" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, "x" : { "type" : "integer", "format" : "int32", "nullable" : true }, "y" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "CustomerShipmentCategoryEnum" : { "type" : "string", "enum" : [ "RMA", "PURCHASE_ORDER", "TRIAL", "UNKNOWN" ] }, "CustomerShipmentEmailStateEnum" : { "type" : "string", "enum" : [ "SHIPPING_CONFIRMATION_SUCCESS", "SHIPPING_CONFIRMATION_FAILURE", "SHIPPING_SHIPPED_SUCCESS", "SHIPPING_SHIPPED_FAILURE", "UNKNOWN" ] }, "CustomerShipmentStateEnum" : { "type" : "string", "enum" : [ "CREATED", "SHIPPED", "DELIVERED", "RETURN_REGISTERED", "RETURN_SENT", "RETURN_DELIVERED", "COMPLETE", "UNKNOWN" ] }, "CustomerShipmentType" : { "type" : "object", "description" : "List of customer shipments", "properties" : { "ait-aitTrackingNumber" : { "type" : "string", "nullable" : true }, "ait-carrierTrackingNumber" : { "type" : "string", "nullable" : true }, "ait-depositorOrderNumber" : { "type" : "string", "nullable" : true }, "ait-destinationAddress" : { "type" : "string", "nullable" : true }, "ait-isIngramDistributorShipment" : { "type" : "boolean", "nullable" : true }, "ait-shipmentDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "ait-shippedItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShippedItemType" }, "nullable" : true }, "interchangeControlNumber" : { "type" : "string", "nullable" : true }, "lastStateUpdateSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "rhombus-additionalEmails" : { "type" : "string", "nullable" : true }, "rhombus-chosenCarrierName" : { "type" : "string", "nullable" : true }, "rhombus-claimKeyToLicenseMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "rhombus-claimKeyToLicenseMapV2" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SalesforceLicenseStartDateTimeAndEndDateTime" }, "nullable" : true }, "nullable" : true }, "rhombus-customerEmails" : { "type" : "string", "nullable" : true }, "rhombus-customerName" : { "type" : "string", "nullable" : true }, "rhombus-orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombus-partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombus-purchaseOrderNumber" : { "type" : "string", "nullable" : true }, "rhombus-rmaReturnTrackingNumber" : { "type" : "string", "nullable" : true }, "rhombus-rmaUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombus-rmaUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "rhombus-salesForceOpportunityId" : { "type" : "string", "nullable" : true }, "rhombus-zendeskTicketNumber" : { "type" : "string", "nullable" : true }, "shipmentCategory" : { "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" }, "shipmentEmailState" : { "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" }, "shipmentState" : { "$ref" : "#/components/schemas/CustomerShipmentStateEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Customer_AcceptUsagePolicyRequest" : { "type" : "object", "description" : "Request object for accepting the usage policy for the current user." }, "Customer_AcceptUsagePolicyResponse" : { "type" : "object", "description" : "Response object for accepting the usage policy for the current user." }, "Customer_CurrentUserSessionTypeEnum" : { "type" : "string", "description" : "USER for a regular login; SUPPORT for a support-authority session acting inside the org.", "enum" : [ "USER", "SUPPORT" ] }, "Customer_CurrentUserSupportSessionWSType" : { "type" : "object", "description" : "Describes the support-authority grant behind the current session. Only present for SUPPORT sessions.", "nullable" : true, "properties" : { "authorityType" : { "$ref" : "#/components/schemas/SupportAuthorityTypeEnum" }, "authorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "email" : { "type" : "string", "description" : "Email of the support user behind the session, when known.", "nullable" : true }, "expirationTimestamp" : { "type" : "integer", "format" : "int64", "description" : "Epoch millis at which the support grant expires, if it expires.", "nullable" : true }, "managedByMsp" : { "type" : "boolean", "description" : "True when the customer org is managed by the partner (MSP) behind the grant.", "nullable" : true }, "name" : { "type" : "string", "description" : "Full name of the support user behind the session, when known.", "nullable" : true }, "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Customer_DeleteNotificationSnoozeSettingWSRequest" : { "type" : "object", "description" : "Request object for deleting notification snooze settings for a specific entity.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Customer_DeleteNotificationSnoozeSettingWSResponse" : { "type" : "object", "description" : "Response object for deleting notification snooze settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_GetCurrentPartnerUserWSRequest" : { "type" : "object", "description" : "Request object for retrieving details about the current authenticated partner user." }, "Customer_GetCurrentPartnerUserWSResponse" : { "type" : "object", "description" : "Response object containing details about the current authenticated partner user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of user-specific flags and settings", "nullable" : true }, "description" : "Map of user-specific flags and settings", "nullable" : true }, "notificationSettingsV2" : { "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "user" : { "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_GetCurrentRhombusKeyUserWSRequest" : { "type" : "object", "description" : "Request object for retrieving RhombusKey user configuration and details for the current user." }, "Customer_GetCurrentRhombusKeyUserWSResponse" : { "type" : "object", "description" : "Response object containing RhombusKey user configuration, user details, and organization summary details.", "properties" : { "orgDetails" : { "$ref" : "#/components/schemas/User_RhombusKeyOrgDetailsType" }, "rhombusKeyConfig" : { "$ref" : "#/components/schemas/RhombusKeyAppConfigType" }, "user" : { "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" } } }, "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSRequest" : { "type" : "object", "description" : "Request object for retrieving organizations that the current user can context switch into for Console." }, "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSResponse" : { "type" : "object", "description" : "Response object containing the list of organizations available for context switching in Console.", "properties" : { "orgs" : { "type" : "array", "description" : "List of organizations that the user can context switch into", "items" : { "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" }, "nullable" : true } } }, "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSRequest" : { "type" : "object", "description" : "Request object for retrieving organizations that the current user can context switch into for Rhombus Key." }, "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSResponse" : { "type" : "object", "description" : "Response object containing the list of organizations available for context switching in Rhombus Key.", "properties" : { "orgs" : { "type" : "array", "description" : "List of organizations that the user can context switch into", "items" : { "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" }, "nullable" : true } } }, "Customer_GetCurrentUserSessionsWSRequest" : { "type" : "object", "description" : "Request object for retrieving the list of active sessions for the current user." }, "Customer_GetCurrentUserSessionsWSResponse" : { "type" : "object", "description" : "Response object containing the list of active sessions for the current user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sessions" : { "type" : "array", "description" : "List of active sessions for the current user", "items" : { "$ref" : "#/components/schemas/SessionInfoWSType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_GetCurrentUserWSRequest" : { "type" : "object", "description" : "Request object for retrieving detailed information about the current authenticated user." }, "Customer_GetCurrentUserWSResponse" : { "type" : "object", "description" : "Response object containing detailed information about the current authenticated user.", "properties" : { "customizations" : { "$ref" : "#/components/schemas/UserCustomizationsType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of user-specific flags and settings", "nullable" : true }, "description" : "Map of user-specific flags and settings", "nullable" : true }, "notificationSettings" : { "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" }, "notificationSettingsV2" : { "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sessionType" : { "$ref" : "#/components/schemas/Customer_CurrentUserSessionTypeEnum" }, "supportSession" : { "$ref" : "#/components/schemas/Customer_CurrentUserSupportSessionWSType" }, "user" : { "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_GetDashboardStatusWSResponse" : { "type" : "object", "description" : "Response object containing dashboard status and information for the current user.", "properties" : { "dashboardStatus" : { "$ref" : "#/components/schemas/DashboardStatus" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_GetDashboardstatusWSRequest" : { "type" : "object", "description" : "Request object for retrieving dashboard status and information for the current user." }, "Customer_GetRhombusKeyConfigForCurrentUserWSRequest" : { "type" : "object", "description" : "Request object for retrieving the RhombusKey mobile app configuration for the current user." }, "Customer_GetRhombusKeyConfigForCurrentUserWSResponse" : { "type" : "object", "description" : "Response object containing the RhombusKey mobile app configuration for the current user.", "properties" : { "userRhombusKeyConfig" : { "$ref" : "#/components/schemas/RhombusKeyAppConfigType" } } }, "Customer_GetUserSnoozedNotificationSettingsWSRequest" : { "type" : "object", "description" : "Request object for retrieving current and planned user notification snooze details." }, "Customer_GetUserSnoozedNotificationSettingsWSResponse" : { "type" : "object", "description" : "Response object containing current and planned user notification snooze details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "snoozedForAllNotificationsIntervals" : { "type" : "array", "description" : "List of intervals when all notifications are snoozed", "items" : { "$ref" : "#/components/schemas/ScheduledIntervalType" }, "nullable" : true }, "snoozedForComponentCompositesMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of component composite UUIDs to their snooze notification intervals", "items" : { "$ref" : "#/components/schemas/ScheduledIntervalType" }, "nullable" : true }, "description" : "Map of component composite UUIDs to their snooze notification intervals", "nullable" : true }, "snoozedForDevicesMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of device UUIDs to their snooze notification intervals", "items" : { "$ref" : "#/components/schemas/ScheduledIntervalType" }, "nullable" : true }, "description" : "Map of device UUIDs to their snooze notification intervals", "nullable" : true }, "snoozedForLocationsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of location UUIDs to their snooze notification intervals", "items" : { "$ref" : "#/components/schemas/ScheduledIntervalType" }, "nullable" : true }, "description" : "Map of location UUIDs to their snooze notification intervals", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_LogoutAllOtherCurrentUserSessionsRequest" : { "type" : "object", "description" : "Request object for logging out all other active sessions for the current user." }, "Customer_LogoutAllOtherCurrentUserSessionsResponse" : { "type" : "object", "description" : "Response object for logging out all other active sessions for the current user." }, "Customer_SelectableOrgForContextSwitch" : { "type" : "object", "description" : "List of organizations that the user can context switch into", "properties" : { "companyThumbnailLogoUrl" : { "type" : "string", "nullable" : true }, "orgName" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombusKeyLogoUrl" : { "type" : "string", "nullable" : true }, "userName" : { "type" : "string", "nullable" : true } } }, "Customer_SetFlagWSRequest" : { "type" : "object", "description" : "Request object for storing a flag or setting for the current user.", "properties" : { "flagName" : { "type" : "string", "description" : "Name of the flag to set", "example" : "feature_enabled", "nullable" : true }, "flagValue" : { "type" : "string", "description" : "Value to set for the flag", "example" : "true", "nullable" : true } } }, "Customer_SetFlagWSResponse" : { "type" : "object", "description" : "Response object for storing a flag or setting for the current user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_SnoozeAllNotificationsWSRequest" : { "type" : "object", "description" : "Request object for snoozing all user notifications for the current user.", "properties" : { "durationSec" : { "type" : "integer", "format" : "int64", "description" : "Duration in seconds for the snooze period", "example" : 3600, "nullable" : true }, "scheduledTimestampSec" : { "type" : "integer", "format" : "int64", "description" : "Scheduled timestamp in seconds when the snooze should start", "example" : 1640995200, "nullable" : true } } }, "Customer_SnoozeAllNotificationsWSResponse" : { "type" : "object", "description" : "Response object for snoozing all user notifications for the current user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_SnoozeNotificationsWSRequest" : { "type" : "object", "description" : "Request object for snoozing user notifications for specific entities.", "properties" : { "componentCompositeUuids" : { "type" : "array", "description" : "List of component composite UUIDs to snooze notifications for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to snooze notifications for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int64", "description" : "Duration in seconds for the snooze period", "example" : 3600, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "List of location UUIDs to snooze notifications for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "scheduledTimestampSec" : { "type" : "integer", "format" : "int64", "description" : "Scheduled timestamp in seconds when the snooze should start", "example" : 1640995200, "nullable" : true } } }, "Customer_SnoozeNotificationsWSResponse" : { "type" : "object", "description" : "Response object for snoozing user notifications for specific entities.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_UpdateCurrentPartnerWSRequest" : { "type" : "object", "description" : "Request object for updating details and information for the current authenticated partner user.", "properties" : { "bypassSaml" : { "type" : "boolean", "description" : "Whether to bypass SAML authentication for this user", "example" : false, "nullable" : true }, "mfaEnabled" : { "type" : "boolean", "description" : "Whether multi-factor authentication is enabled for the user", "example" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the partner user", "example" : "John Doe", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "smsPhoneNumbers" : { "type" : "array", "description" : "List of SMS phone numbers for the user", "items" : { "type" : "string", "description" : "List of SMS phone numbers for the user", "nullable" : true }, "nullable" : true }, "summaryEmailEnabled" : { "type" : "boolean", "description" : "Whether summary emails are enabled for the user", "example" : false, "nullable" : true } } }, "Customer_UpdateCurrentPartnerWSResponse" : { "type" : "object", "description" : "Response object for updating details and information for the current authenticated partner user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_UpdateCurrentUserWSRequest" : { "type" : "object", "description" : "Request object for updating details and information for the current authenticated user.", "properties" : { "dashboardCustomizations" : { "$ref" : "#/components/schemas/DashboardCustomizations" }, "mfaEnabled" : { "type" : "boolean", "description" : "Whether multi-factor authentication is enabled for the user", "example" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the user", "example" : "John Doe", "nullable" : true }, "notificationIntervalsV2" : { "type" : "array", "description" : "List of notification intervals for the user", "items" : { "$ref" : "#/components/schemas/NotificationIntervalV2Type" }, "nullable" : true }, "smsPhoneNumbers" : { "type" : "array", "description" : "List of SMS phone numbers for the user", "items" : { "type" : "string", "description" : "List of SMS phone numbers for the user", "nullable" : true }, "nullable" : true }, "summaryEmailEnabled" : { "type" : "boolean", "description" : "Whether summary emails are enabled for the user", "example" : false, "nullable" : true } } }, "Customer_UpdateCurrentUserWSResponse" : { "type" : "object", "description" : "Response object for updating details and information for the current authenticated user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_UpdateDashboardCustomizationsWSRequest" : { "type" : "object", "description" : "Request object for updating dashboard customization settings for the current user.", "properties" : { "fullCamera" : { "type" : "string", "description" : "Full camera configuration", "example" : "single", "nullable" : true }, "fullCameraUpdated" : { "type" : "boolean", "description" : "Whether the full camera has been updated", "example" : false, "nullable" : true }, "halfCamera" : { "type" : "string", "description" : "Half camera configuration", "example" : "split", "nullable" : true }, "halfCameraUpdated" : { "type" : "boolean", "description" : "Whether the half camera has been updated", "example" : true, "nullable" : true }, "layout" : { "type" : "string", "description" : "Dashboard layout configuration", "example" : "grid", "nullable" : true }, "layoutUpdated" : { "type" : "boolean", "description" : "Whether the layout has been updated", "example" : true, "nullable" : true }, "rememberedLocation" : { "type" : "string", "description" : "Remembered location for the user", "example" : "Main Office", "nullable" : true }, "rememberedLocationUpdated" : { "type" : "boolean", "description" : "Whether the remembered location has been updated", "example" : false, "nullable" : true }, "report" : { "type" : "string", "description" : "Report configuration", "example" : "daily", "nullable" : true }, "reportUpdated" : { "type" : "boolean", "description" : "Whether the report has been updated", "example" : true, "nullable" : true }, "videoWall" : { "type" : "string", "description" : "Video wall configuration", "example" : "4x4", "nullable" : true }, "videoWallUpdated" : { "type" : "boolean", "description" : "Whether the video wall has been updated", "example" : false, "nullable" : true } } }, "Customer_UpdateDashboardCustomizationsWSResponse" : { "type" : "object", "description" : "Response object for updating dashboard customization settings for the current user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_UpdateFrontendCustomizationsWSRequest" : { "type" : "object", "description" : "Request object for updating frontend customization settings for the current user.", "properties" : { "customizations" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of frontend customization settings and their values", "nullable" : true }, "description" : "Map of frontend customization settings and their values", "nullable" : true } } }, "Customer_UpdateFrontendCustomizationsWSResponse" : { "type" : "object", "description" : "Response object for updating frontend customization settings for the current user.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSRequest" : { "type" : "object", "description" : "Request object for updating the RhombusKey mobile app preferences for the current user.", "properties" : { "favoriteAccessControlledDoorUuids" : { "type" : "array", "description" : "List of favorite access controlled door UUIDs for the user", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "favoriteAccessControlledDoorUuidsUpdated" : { "type" : "boolean", "description" : "Whether the favorite access controlled door UUIDs have been updated", "example" : true, "nullable" : true }, "favoriteAccessControlledElevatorUuids" : { "type" : "array", "description" : "List of favorite access controlled elevator UUIDs for the user", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "favoriteAccessControlledElevatorUuidsUpdated" : { "type" : "boolean", "description" : "Whether the favorite access controlled elevator UUIDs have been updated", "example" : true, "nullable" : true } } }, "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSResponse" : { "type" : "object", "description" : "Response object for updating the RhombusKey mobile app preferences for the current user.", "properties" : { "userRhombusKeyConfig" : { "$ref" : "#/components/schemas/RhombusKeyAppConfigType" } } }, "DailyFirstInReset" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "minuteOfDay" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/FirstInResetEnum" } } }, "DailyMinuteIntervalType" : { "type" : "object", "nullable" : true, "properties" : { "minuteOfDayStartInclusive" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfDayStopExclusive" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DaoOutcomeEnum" : { "type" : "string", "description" : "The result of the ALM-related action.", "enum" : [ "SUCCESS", "BAD_REQUEST", "NO_SUCH_ENTITY", "ALREADY_EXISTS", "STALE_UPDATE", "CONCURRENCY_ERROR", "INTERNAL_ERROR", "UNKNOWN" ] }, "DashboardCustomizations" : { "type" : "object", "description" : "Dashboard customization settings for the user", "properties" : { "fullCamera" : { "type" : "string", "nullable" : true }, "halfCamera" : { "type" : "string", "nullable" : true }, "layout" : { "type" : "string", "nullable" : true }, "rememberedLocation" : { "type" : "string", "nullable" : true }, "report" : { "type" : "string", "nullable" : true }, "videoWall" : { "type" : "string", "nullable" : true } } }, "DashboardHealthStatusIndicationEnum" : { "type" : "string", "enum" : [ "GREEN", "YELLOW", "RED" ] }, "DashboardStatus" : { "type" : "object", "description" : "Dashboard status and information for the current user", "properties" : { "camerasDown" : { "type" : "integer", "format" : "int32", "nullable" : true }, "camerasDownByLocation" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "camerasUp" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatusIndicator" : { "$ref" : "#/components/schemas/DashboardHealthStatusIndicationEnum" }, "healthStatusMsg" : { "type" : "string", "nullable" : true }, "locationCameraStatus" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "nullable" : true }, "totalCameras" : { "type" : "integer", "format" : "int32", "nullable" : true }, "totalClimateSensors" : { "type" : "integer", "format" : "int32", "nullable" : true }, "totalDoorSensors" : { "type" : "integer", "format" : "int32", "nullable" : true }, "totalLocations" : { "type" : "integer", "format" : "int32", "nullable" : true }, "totalProximitySensors" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DataRetentionSettingsType" : { "type" : "object", "nullable" : true, "properties" : { "faceEventRetentionDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "licensePlateEventRetentionDays" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DataSourceEnum" : { "type" : "string", "enum" : [ "ACCESS_CONTROL_EVENTS", "BANDWIDTH_USAGE", "CAMERA_EVENTS", "CAMERAS", "CLIMATE_SENSOR_EVENTS", "CLIPS", "COMPONENT_EVENTS", "CROWD", "CUSTOM_LLM_EVENTS", "ENTITIES", "ENVIRONMENTAL_GATEWAY_EVENTS", "FACES", "LICENSE_PLATE_RECOGNITION", "LINE_CROSSING", "LOCATIONS", "MOTION", "OCCUPANCY", "PEOPLE", "POLICY_ALERTS", "VEHICLES" ] }, "DateRangeFilter" : { "type" : "object", "description" : "Optional date range filter to limit search results.", "properties" : { "localEndDateRangeEnd" : { "type" : "string", "description" : "End of the date range to filter local end date. This date is inclusive.", "nullable" : true }, "localEndDateRangeStart" : { "type" : "string", "description" : "Start of the date range to filter local end date. This date is inclusive.", "nullable" : true }, "localStartDateRangeEnd" : { "type" : "string", "description" : "End of the date range to filter local start date. This date is inclusive.", "nullable" : true }, "localStartDateRangeStart" : { "type" : "string", "description" : "Start of the date range to filter local start date. This date is inclusive.", "nullable" : true } } }, "DeleteCoOccurrenceRuleRequest" : { "type" : "object", "properties" : { "orgUuid" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "nullable" : true } } }, "DeleteCoOccurrenceRuleResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true } } }, "DeleteSharedLiveVideoStreamForDeviceResponse" : { "type" : "object" }, "DeleteTailgatingRuleResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true } } }, "DemographicsHourlyBucket" : { "type" : "object", "description" : "Hourly demographics buckets", "properties" : { "ageDistribution" : { "type" : "object", "additionalProperties" : { "type" : "number", "nullable" : true }, "nullable" : true }, "genderDistribution" : { "type" : "object", "additionalProperties" : { "type" : "number", "nullable" : true }, "nullable" : true }, "hourBucket" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true }, "totalDetections" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Demographics_GetDemographicsDataWSRequest" : { "type" : "object", "description" : "Request for demographics data.", "properties" : { "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds", "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds", "nullable" : true } } }, "Demographics_GetDemographicsDataWSResponse" : { "type" : "object", "description" : "Response containing demographics data.", "properties" : { "buckets" : { "type" : "array", "description" : "Hourly demographics buckets", "items" : { "$ref" : "#/components/schemas/DemographicsHourlyBucket" }, "nullable" : true } } }, "DeployRobotAction" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "mapUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "navType" : { "$ref" : "#/components/schemas/NavigationTypeEnum" }, "pose" : { "$ref" : "#/components/schemas/Pose" }, "routeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waypointUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/RobotActionTypeEnum" } } }, "DetectionFeedbackReasonEnum" : { "type" : "string", "description" : "Why the detection is being reported", "enum" : [ "FALSE_POSITIVE", "MISSED_DETECTION", "OTHER" ] }, "Developer_CreateEventListenerWSRequest" : { "type" : "object", "description" : "Request object for creating an event listener.", "properties" : { "eventListner" : { "$ref" : "#/components/schemas/EventListenerType" } } }, "Developer_CreateEventListenerWSResponse" : { "type" : "object", "description" : "Response object for creating an event listener.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "eventListenerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Developer_DeleteEventListenerWSRequest" : { "type" : "object", "description" : "Request object for deleting an event listener.", "properties" : { "eventListenerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Developer_DeleteEventListenerWSResponse" : { "type" : "object", "description" : "Response object for deleting an event listener.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Developer_GetAllEventListenersWSRequest" : { "type" : "object", "description" : "Request object for retrieving a list of all event listeners." }, "Developer_GetAllEventListenersWSResponse" : { "type" : "object", "description" : "Response object containing a list of all event listeners.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "eventListeners" : { "type" : "array", "description" : "List of all event listeners", "items" : { "$ref" : "#/components/schemas/EventListenerType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Developer_GetEventListenersForDeviceWSRequest" : { "type" : "object", "description" : "Request object for retrieving a list of event listeners for a specific device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Developer_GetEventListenersForDeviceWSResponse" : { "type" : "object", "description" : "Response object containing a list of event listeners for a specific device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "eventListeners" : { "type" : "array", "description" : "List of event listeners for the specified device", "items" : { "$ref" : "#/components/schemas/EventListenerType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "DeviceActivityRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/SimpleDeviceActivityEventType" }, "componentCompositeUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "componentUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "deviceLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "locationUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "DeviceAssignableLicenseGroupStats" : { "type" : "object", "properties" : { "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "deviceLicenseFamilyStats" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" }, "nullable" : true }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "DeviceCatalogItem" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" } } } ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "DeviceDisabledHealthTrackingInfo" : { "type" : "object", "description" : "List of organization devices for which health tracking is disabled.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reEnableCondition" : { "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" } } }, "DeviceEventRecordType" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hardwareVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DeviceFacetEnum" : { "type" : "string", "format" : "DeviceFacet", "description" : "facet information for media", "enum" : [ "", "v0", "v1", "v2", "v3", "a0", "v4", "v5", "v6", "v7", "v8", "v9", "v10", "v11", "v12", "v13", "v14", "v15", "v16", "v17", "v18", "v19", "v20", "v21", "v22", "v23", "v24", "v25", "v26", "v27", "v28", "v29", "v30", "v31", "v32", "v33", "v34", "v35", "v36", "v37", "v38", "v39", "v40", "v41", "v42", "v43", "v44", "v45", "v46", "v47", "v48", "v49", "v50", "v51", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "a10", "a11", "a12", "a13", "a14", "a15", "a16", "a17", "a18", "a19", "a20", "a21", "a22", "a23", "a24", "a25", "a26", "a27", "a28", "a29", "a30", "a31", "a32", "a33", "a34", "a35", "a36", "a37", "a38", "a39", "a40", "a41", "a42", "a43", "a44", "a45", "a46", "a47", "a48", "a49", "a50", "a51" ], "example" : "v0, a0" }, "DeviceFeatureEnum" : { "type" : "string", "enum" : [ "COLOR_SEARCH", "FACE_RECOGNITION", "LICENSE_PLATE_RECOGNITION", "PEOPLE_COUNTING", "PPE_DETECTION", "UNUSUAL_BEHAVIOR_DETECTION", "VEHICLE_COUNTING", "CAMERA_ENTERPRISE_CLOUD_ARCHIVING", "TIMELAPSE", "VISUAL_TAMPER", "REGION_CROSSING", "OCCUPANCY_COUNTING", "CUSTOM_EVENTS", "LOITER", "PEOPLE_TRACKING", "REIDENTIFICATION", "INACTIVITY_DETECTION", "AUDIO_AI_ANALYTICS", "AUDIO_ENTERPRISE_CLOUD_ARCHIVING", "AUDIO_SPEAKER_ENABLED", "BADGE_READER_ENTERPRISE_CLOUD_ARCHIVING", "OBJECT_SEARCH", "UNKNOWN" ] }, "DeviceHealthStatusDetailsEnum" : { "type" : "string", "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NOT_RECORDING", "LINK_SPEED_LOW", "MALFUNCTIONING_MODULES", "CALIBRATING", "DELAYED", "NONE" ] }, "DeviceIntegrationSettings" : { "type" : "object", "nullable" : true, "properties" : { "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "DeviceIntegrationType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deviceSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DeviceIntegrationSettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DeviceLicenseFamilyEnum" : { "type" : "string", "enum" : [ "CAMERA", "CAMERA_MS", "VIDEO_INTERCOM", "AUDIO_GATEWAY", "ENVIRONMENTAL_SENSOR", "ENVIRONMENTAL_GATEWAY" ] }, "DeviceLicenseFamilyStats" : { "type" : "object", "properties" : { "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "deviceLicenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "DeviceLicenseType" : { "type" : "object", "description" : "List of device licenses available for the client organization", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "features" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LicenseFeature" }, "nullable" : true, "uniqueItems" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DeviceOrientationEnum" : { "type" : "string", "enum" : [ "CEILING", "FLOOR", "WALL", "WALL_CROOKED", "INDETERMINATE" ] }, "DevicePhysicalPortConfigType" : { "type" : "object", "properties" : { "boardMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BoardPhysicalPortConfigType" }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DeviceSchedule" : { "type" : "object", "properties" : { "invertSchedule" : { "type" : "boolean", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "unscheduledMessage" : { "type" : "string", "nullable" : true } } }, "DeviceServiceEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serviceName" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, "DeviceStatusEnum" : { "type" : "string", "enum" : [ "RED", "ORANGE", "YELLOW", "GREEN" ] }, "DeviceTargetScopeEnum" : { "type" : "string", "enum" : [ "ORG", "LOCATION", "DEVICE" ] }, "DeviceTypeEnum" : { "type" : "string", "enum" : [ "BLE_TRACKER", "CAMERA", "DOOR_SENSOR", "ENVIRONMENTAL_SENSOR", "OCCUPANCY_SENSOR", "AUDIO_GATEWAY", "EXECUTABLE", "BADGE_READER", "DOOR_CONTROLLER", "BLE_BUTTON", "IO_BOARD", "ENVIRONMENTAL_GATEWAY", "NVR", "ROBOT", "UNKNOWN" ] }, "DeviceTypeV2" : { "type" : "object", "description" : "List of all client devices", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "customData" : { "type" : "string", "nullable" : true }, "deleted" : { "type" : "boolean", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "hardwareId" : { "type" : "string", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pending" : { "type" : "boolean", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "unregisteredEmailSent" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DeviceVideoSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update selective video settings", "properties" : { "alert_rate_limit_human_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "alert_rate_limit_motion_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "alert_rate_limit_vehicle_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "ir_double_tap" : { "type" : "boolean", "nullable" : true }, "ir_filter_mode" : { "$ref" : "#/components/schemas/IRModesEnum" }, "ir_leds_mode" : { "$ref" : "#/components/schemas/IRModesEnum" }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "Device_config_GetConfigWSRequest" : { "type" : "object", "description" : "Request object for retrieving a device's configuration.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Device_config_GetFacetedUserConfigWSResponse" : { "type" : "object", "description" : "Response object containing a device's faceted user configuration.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Device_config_UpdateFacetedUserConfigWSRequest" : { "type" : "object", "description" : "Request object for updating a device's faceted user configuration.", "properties" : { "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" } } }, "Device_config_settings_ExternalAudioSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Audio settings", "properties" : { "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_min_echo_amplitude" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_record" : { "type" : "boolean", "nullable" : true }, "audio_supported" : { "type" : "boolean", "nullable" : true }, "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, "device_mic_enabled" : { "type" : "boolean", "nullable" : true }, "device_near_audio_silenced" : { "type" : "boolean", "nullable" : true }, "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" : { "type" : "object", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "scanner_agent_disabled" : { "type" : "boolean", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Door Controller settings", "properties" : { "autocomponentize_readers" : { "type" : "boolean", "nullable" : true }, "autoregister_readers" : { "type" : "boolean", "nullable" : true }, "flip_display_orientation" : { "type" : "boolean", "nullable" : true }, "mdns_advertise_enabled" : { "type" : "boolean", "nullable" : true }, "mdns_discover_enabled" : { "type" : "boolean", "nullable" : true }, "peer_address_mode" : { "$ref" : "#/components/schemas/PeerAddressModeEnum" }, "peer_channel_mode" : { "$ref" : "#/components/schemas/PeerChannelModeEnum" }, "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_disabled" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_distance_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "Device_config_settings_ExternalReadableAudioSettings" : { "type" : "object", "properties" : { "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, "audio_analysis_enabled" : { "type" : "boolean", "nullable" : true }, "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_min_echo_amplitude" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_record" : { "type" : "boolean", "nullable" : true }, "audio_supported" : { "type" : "boolean", "nullable" : true }, "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, "device_mic_enabled" : { "type" : "boolean", "nullable" : true }, "device_near_audio_silenced" : { "type" : "boolean", "nullable" : true }, "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true } } }, "Device_config_settings_ExternalReadableButtonSettings" : { "type" : "object", "properties" : { "button_emergency_onsite_contact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "button_test_mode_enabled" : { "type" : "boolean", "nullable" : true } } }, "Device_config_settings_ExternalReadableDeviceSettings" : { "type" : "object", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_archive_days" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cloud_archive_upload_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "cloud_archive_upload_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "max_event_duration_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "scanner_agent_disabled" : { "type" : "boolean", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" } } }, "Device_config_settings_ExternalReadableDeviceVideoSettings" : { "type" : "object", "properties" : { "alert_rate_limit_human_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "alert_rate_limit_motion_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "alert_rate_limit_vehicle_only" : { "$ref" : "#/components/schemas/BurstyRateLimit" }, "ir_double_tap" : { "type" : "boolean", "nullable" : true }, "ir_filter_mode" : { "$ref" : "#/components/schemas/IRModesEnum" }, "ir_leds_mode" : { "$ref" : "#/components/schemas/IRModesEnum" } } }, "Device_config_settings_ExternalReadableDoorControllerSettings" : { "type" : "object", "properties" : { "autocomponentize_readers" : { "type" : "boolean", "nullable" : true }, "autoregister_readers" : { "type" : "boolean", "nullable" : true }, "flip_display_orientation" : { "type" : "boolean", "nullable" : true }, "mdns_advertise_enabled" : { "type" : "boolean", "nullable" : true }, "mdns_discover_enabled" : { "type" : "boolean", "nullable" : true }, "peer_address_mode" : { "$ref" : "#/components/schemas/PeerAddressModeEnum" }, "peer_channel_mode" : { "$ref" : "#/components/schemas/PeerChannelModeEnum" }, "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_disabled" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_distance_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "Device_config_settings_ExternalReadableVideoSettings" : { "type" : "object", "properties" : { "ai_dewarp_config" : { "$ref" : "#/components/schemas/CameraAiDewarpConfigType" }, "behavior_detection" : { "type" : "boolean", "nullable" : true }, "blocked_debounce_time_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "blocked_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "char_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "color_detection" : { "type" : "boolean", "nullable" : true }, "con_human_filter" : { "type" : "integer", "format" : "int32", "nullable" : true }, "con_vehicle_filter" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cross_counting" : { "type" : "boolean", "nullable" : true }, "cross_counting_settings" : { "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" }, "custom_events" : { "type" : "boolean", "nullable" : true }, "dewarpMode" : { "$ref" : "#/components/schemas/CameraDewarpModeEnum" }, "disabled_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "disabled_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "disabled_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "engagement_counting" : { "type" : "boolean", "nullable" : true }, "exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "face_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_counting" : { "type" : "boolean", "nullable" : true }, "face_counting_nonunique" : { "type" : "boolean", "nullable" : true }, "face_id_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_match_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_recognition" : { "type" : "boolean", "nullable" : true }, "fisheye_display_mode" : { "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" }, "floorplan_homography" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "nullable" : true }, "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "h265_vod_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "hdr_enabled" : { "type" : "boolean", "nullable" : true }, "high_res_detection" : { "type" : "boolean", "nullable" : true }, "human_detection" : { "type" : "boolean", "nullable" : true }, "human_loitering" : { "type" : "boolean", "nullable" : true }, "human_loitering_settings" : { "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" }, "img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inactivity_settings" : { "$ref" : "#/components/schemas/CameraInactivitySettingsType" }, "licenseplate_detection" : { "type" : "boolean", "nullable" : true }, "lpr_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "max_detections_per_frame" : { "type" : "integer", "format" : "int32", "nullable" : true }, "metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "motion_grid_disabled" : { "type" : "boolean", "nullable" : true }, "motion_grid_window_sec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "motion_lightweight_disabled" : { "type" : "boolean", "nullable" : true }, "motion_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "motor_config" : { "$ref" : "#/components/schemas/CameraMotorConfigType" }, "mounting_direction" : { "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "new_motion_feature_flag" : { "type" : "boolean", "nullable" : true }, "night_exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "night_sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "obj_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "object_search" : { "type" : "boolean", "nullable" : true }, "occupancy_count_high_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_count_low_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_counting" : { "type" : "boolean", "nullable" : true }, "people_counting" : { "type" : "boolean", "nullable" : true }, "people_tracking" : { "type" : "boolean", "nullable" : true }, "person_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "person_reidentification" : { "type" : "boolean", "nullable" : true }, "pose_detection" : { "type" : "boolean", "nullable" : true }, "ppe_detection" : { "type" : "boolean", "nullable" : true }, "privacy_window_polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, "privacy_windows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PermyriadRect" }, "nullable" : true }, "ptz_config" : { "$ref" : "#/components/schemas/CameraPTZConfigType" }, "ptz_home" : { "$ref" : "#/components/schemas/CameraPtzHome" }, "record_on_motion" : { "type" : "boolean", "nullable" : true }, "region_for_occupancy" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest_groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rtsp_encoder" : { "type" : "integer", "format" : "int32", "nullable" : true }, "segment_max_bytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shared_fov" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_interval_secs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "target_ai_fps" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_disabled" : { "type" : "boolean", "nullable" : true }, "tile_views" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "timelapse" : { "type" : "boolean", "nullable" : true }, "upload_all_detections" : { "type" : "boolean", "nullable" : true }, "use_onboard_ai" : { "type" : "boolean", "nullable" : true }, "use_onboard_lpr" : { "type" : "boolean", "nullable" : true }, "use_pilot_face_id" : { "type" : "boolean", "nullable" : true }, "vehicle_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vehicle_counting" : { "type" : "boolean", "nullable" : true }, "vehicle_detection" : { "type" : "boolean", "nullable" : true }, "video_ai_disabled" : { "type" : "boolean", "nullable" : true }, "video_persist_disabled" : { "type" : "boolean", "nullable" : true }, "visual_tamper_config" : { "$ref" : "#/components/schemas/CameraVisualTamperConfigType" }, "wdr_enabled" : { "type" : "boolean", "nullable" : true }, "wdr_strength" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_bitrate_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_quality" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_settings_ExternalVideoResolution" : { "type" : "object", "properties" : { "height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "width" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_settings_ExternalVideoSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Video Settings", "properties" : { "blocked_debounce_time_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "blocked_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "char_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "custom_events" : { "type" : "boolean", "nullable" : true }, "dewarpMode" : { "$ref" : "#/components/schemas/CameraDewarpModeEnum" }, "disabled_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "disabled_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "disabled_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "fisheye_display_mode" : { "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" }, "floorplan_homography" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "nullable" : true }, "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "h265_vod_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "hdr_enabled" : { "type" : "boolean", "nullable" : true }, "high_res_detection" : { "type" : "boolean", "nullable" : true }, "human_detection" : { "type" : "boolean", "nullable" : true }, "human_loitering" : { "type" : "boolean", "nullable" : true }, "human_loitering_settings" : { "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" }, "img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inactivity_settings" : { "$ref" : "#/components/schemas/CameraInactivitySettingsType" }, "max_detections_per_frame" : { "type" : "integer", "format" : "int32", "nullable" : true }, "metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "motor_config" : { "$ref" : "#/components/schemas/CameraMotorConfigType" }, "mounting_direction" : { "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "night_exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "night_sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "object_search" : { "type" : "boolean", "nullable" : true }, "occupancy_count_high_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_count_low_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_counting" : { "type" : "boolean", "nullable" : true }, "people_tracking" : { "type" : "boolean", "nullable" : true }, "person_reidentification" : { "type" : "boolean", "nullable" : true }, "privacy_window_polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, "privacy_windows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PermyriadRect" }, "nullable" : true }, "ptz_config" : { "$ref" : "#/components/schemas/CameraPTZConfigType" }, "ptz_home" : { "$ref" : "#/components/schemas/CameraPtzHome" }, "record_on_motion" : { "type" : "boolean", "nullable" : true }, "region_for_occupancy" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest_groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rtsp_encoder" : { "type" : "integer", "format" : "int32", "nullable" : true }, "segment_max_bytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shared_fov" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_interval_secs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tile_views" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "upload_all_detections" : { "type" : "boolean", "nullable" : true }, "use_onboard_lpr" : { "type" : "boolean", "nullable" : true }, "vehicle_detection" : { "type" : "boolean", "nullable" : true }, "video_ai_disabled" : { "type" : "boolean", "nullable" : true }, "video_persist_disabled" : { "type" : "boolean", "nullable" : true }, "wdr_enabled" : { "type" : "boolean", "nullable" : true }, "wdr_strength" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_bitrate_percent" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_settings_IntRange" : { "type" : "object", "properties" : { "max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "min" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_settings_VideoConfigurationDefault" : { "type" : "object", "description" : "Map of hardware variations to default video configurations", "properties" : { "humanDetection" : { "type" : "boolean", "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "segmentMaxBytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensorGainMax" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shutterTimeMin" : { "type" : "integer", "format" : "int32", "nullable" : true }, "vehicleDetection" : { "type" : "boolean", "nullable" : true } } }, "Device_config_settings_VideoConfigurationOption" : { "type" : "object", "description" : "Map of hardware variations to available video configuration options", "properties" : { "maxBitrateRange" : { "$ref" : "#/components/schemas/Device_config_settings_IntRange" }, "maxZoomPercent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "wdrRange" : { "$ref" : "#/components/schemas/Device_config_settings_IntRange" } } }, "Device_config_userconfig_ExternalReadableFacetedUserConfig" : { "type" : "object", "description" : "Device's faceted user configuration", "properties" : { "audioFacetSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableAudioSettings" }, "nullable" : true }, "buttonSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableButtonSettings" }, "climateSettings" : { "$ref" : "#/components/schemas/ClimateSettings" }, "deviceSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceSettings" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceVideoSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceVideoSettings" }, "doorControllerSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDoorControllerSettings" }, "doorReaderSettings" : { "$ref" : "#/components/schemas/DoorReaderSettings" }, "doorSensorSettings" : { "$ref" : "#/components/schemas/DoorSensorSettings" }, "environmentalGatewaySettings" : { "$ref" : "#/components/schemas/EnvironmentalGatewaySettings" }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "metricsAgentSettings" : { "$ref" : "#/components/schemas/MetricsAgentSettings" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "robotSettings" : { "$ref" : "#/components/schemas/RobotSettings" }, "tamperSettings" : { "$ref" : "#/components/schemas/TamperSettings" }, "thirdPartyCameraSettings" : { "$ref" : "#/components/schemas/ThirdPartyCameraSettings" }, "videoDoorbellSettings" : { "$ref" : "#/components/schemas/VideoDoorbellSettings" }, "videoFacetSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableVideoSettings" }, "nullable" : true } } }, "Device_config_userconfig_ExternalUpdateableFacetedUserConfig" : { "type" : "object", "description" : "Configuration updates to apply to the device", "properties" : { "audioFacetSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalAudioSettingsSelectiveUpdate" }, "description" : "Update Audio settings", "nullable" : true }, "buttonSettings" : { "$ref" : "#/components/schemas/ButtonSettingsSelectiveUpdate" }, "climateSettings" : { "$ref" : "#/components/schemas/ClimateSettingsSelectiveUpdate" }, "deviceSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceVideoSettings" : { "$ref" : "#/components/schemas/DeviceVideoSettingsSelectiveUpdate" }, "doorControllerSettings" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" }, "doorReaderSettings" : { "$ref" : "#/components/schemas/DoorReaderSettingsSelectiveUpdate" }, "doorSensorSettings" : { "$ref" : "#/components/schemas/DoorSensorSettingsSelectiveUpdate" }, "environmentalGatewaySettings" : { "$ref" : "#/components/schemas/EnvironmentalGatewaySettingsSelectiveUpdate" }, "metricsAgentSettings" : { "$ref" : "#/components/schemas/MetricsAgentSettingsSelectiveUpdate" }, "robotSettings" : { "$ref" : "#/components/schemas/RobotSettingsSelectiveUpdate" }, "tamperSettings" : { "$ref" : "#/components/schemas/TamperSettingsSelectiveUpdate" }, "videoDoorbellSettings" : { "$ref" : "#/components/schemas/VideoDoorbellSettingsSelectiveUpdate" }, "videoFacetSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoSettingsSelectiveUpdate" }, "description" : "Update Video Settings", "nullable" : true } } }, "Device_config_userconfig_IExternalReadableAudioVideoUserConfig" : { "type" : "object", "description" : "Doorbell camera configuration settings", "properties" : { "ai_dewarp_config" : { "$ref" : "#/components/schemas/CameraAiDewarpConfigType" }, "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, "audio_analysis_enabled" : { "type" : "boolean", "nullable" : true }, "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_min_echo_amplitude" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_record" : { "type" : "boolean", "nullable" : true }, "audio_supported" : { "type" : "boolean", "nullable" : true }, "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "behavior_detection" : { "type" : "boolean", "nullable" : true }, "blocked_debounce_time_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "blocked_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "char_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_archive_days" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cloud_archive_upload_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "cloud_archive_upload_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "color_detection" : { "type" : "boolean", "nullable" : true }, "con_human_filter" : { "type" : "integer", "format" : "int32", "nullable" : true }, "con_vehicle_filter" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cross_counting" : { "type" : "boolean", "nullable" : true }, "cross_counting_settings" : { "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" }, "custom_events" : { "type" : "boolean", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "device_mic_enabled" : { "type" : "boolean", "nullable" : true }, "device_near_audio_silenced" : { "type" : "boolean", "nullable" : true }, "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, "dewarpMode" : { "$ref" : "#/components/schemas/CameraDewarpModeEnum" }, "disabled_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "disabled_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "disabled_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "engagement_counting" : { "type" : "boolean", "nullable" : true }, "exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "face_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_counting" : { "type" : "boolean", "nullable" : true }, "face_counting_nonunique" : { "type" : "boolean", "nullable" : true }, "face_id_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_match_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "face_recognition" : { "type" : "boolean", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "fisheye_display_mode" : { "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" }, "floorplan_homography" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "h265_vod_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "hdr_enabled" : { "type" : "boolean", "nullable" : true }, "high_res_detection" : { "type" : "boolean", "nullable" : true }, "human_detection" : { "type" : "boolean", "nullable" : true }, "human_loitering" : { "type" : "boolean", "nullable" : true }, "human_loitering_settings" : { "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" }, "img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inactivity_settings" : { "$ref" : "#/components/schemas/CameraInactivitySettingsType" }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "licenseplate_detection" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "lpr_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "max_detections_per_frame" : { "type" : "integer", "format" : "int32", "nullable" : true }, "max_event_duration_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "motion_grid_disabled" : { "type" : "boolean", "nullable" : true }, "motion_grid_window_sec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "motion_lightweight_disabled" : { "type" : "boolean", "nullable" : true }, "motion_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "motor_config" : { "$ref" : "#/components/schemas/CameraMotorConfigType" }, "mounting_direction" : { "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "new_motion_feature_flag" : { "type" : "boolean", "nullable" : true }, "night_exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "night_sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "obj_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "object_search" : { "type" : "boolean", "nullable" : true }, "occupancy_count_high_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_count_low_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_counting" : { "type" : "boolean", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "people_counting" : { "type" : "boolean", "nullable" : true }, "people_tracking" : { "type" : "boolean", "nullable" : true }, "person_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "person_reidentification" : { "type" : "boolean", "nullable" : true }, "pose_detection" : { "type" : "boolean", "nullable" : true }, "ppe_detection" : { "type" : "boolean", "nullable" : true }, "privacy_window_polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, "privacy_windows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PermyriadRect" }, "nullable" : true }, "ptz_config" : { "$ref" : "#/components/schemas/CameraPTZConfigType" }, "ptz_home" : { "$ref" : "#/components/schemas/CameraPtzHome" }, "record_on_motion" : { "type" : "boolean", "nullable" : true }, "region_for_occupancy" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest_groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rtsp_encoder" : { "type" : "integer", "format" : "int32", "nullable" : true }, "segment_max_bytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shared_fov" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_interval_secs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "target_ai_fps" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_disabled" : { "type" : "boolean", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "tile_views" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "timelapse" : { "type" : "boolean", "nullable" : true }, "upload_all_detections" : { "type" : "boolean", "nullable" : true }, "use_onboard_ai" : { "type" : "boolean", "nullable" : true }, "use_onboard_lpr" : { "type" : "boolean", "nullable" : true }, "use_pilot_face_id" : { "type" : "boolean", "nullable" : true }, "vehicle_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vehicle_counting" : { "type" : "boolean", "nullable" : true }, "vehicle_detection" : { "type" : "boolean", "nullable" : true }, "video_ai_disabled" : { "type" : "boolean", "nullable" : true }, "video_persist_disabled" : { "type" : "boolean", "nullable" : true }, "visual_tamper_config" : { "$ref" : "#/components/schemas/CameraVisualTamperConfigType" }, "wdr_enabled" : { "type" : "boolean", "nullable" : true }, "wdr_strength" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_bitrate_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_quality" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_userconfig_IExternalReadableDoorControllerUserConfig" : { "type" : "object", "description" : "Door controller configuration settings", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "autocomponentize_readers" : { "type" : "boolean", "nullable" : true }, "autoregister_readers" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_archive_days" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cloud_archive_upload_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "cloud_archive_upload_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "flip_display_orientation" : { "type" : "boolean", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "max_event_duration_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "mdns_advertise_enabled" : { "type" : "boolean", "nullable" : true }, "mdns_discover_enabled" : { "type" : "boolean", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "peer_address_mode" : { "$ref" : "#/components/schemas/PeerAddressModeEnum" }, "peer_channel_mode" : { "$ref" : "#/components/schemas/PeerChannelModeEnum" }, "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_disabled" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_distance_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" } } }, "Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" : { "type" : "object", "description" : "Audio/video user configuration update", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_min_echo_amplitude" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_record" : { "type" : "boolean", "nullable" : true }, "audio_supported" : { "type" : "boolean", "nullable" : true }, "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "blocked_debounce_time_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "blocked_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "char_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "custom_events" : { "type" : "boolean", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "device_mic_enabled" : { "type" : "boolean", "nullable" : true }, "device_near_audio_silenced" : { "type" : "boolean", "nullable" : true }, "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, "dewarpMode" : { "$ref" : "#/components/schemas/CameraDewarpModeEnum" }, "disabled_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "disabled_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "disabled_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "fisheye_display_mode" : { "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" }, "floorplan_homography" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "h265_vod_encoding_enabled" : { "type" : "boolean", "nullable" : true }, "hdr_enabled" : { "type" : "boolean", "nullable" : true }, "high_res_detection" : { "type" : "boolean", "nullable" : true }, "human_detection" : { "type" : "boolean", "nullable" : true }, "human_loitering" : { "type" : "boolean", "nullable" : true }, "human_loitering_settings" : { "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" }, "img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inactivity_settings" : { "$ref" : "#/components/schemas/CameraInactivitySettingsType" }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "max_detections_per_frame" : { "type" : "integer", "format" : "int32", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "motor_config" : { "$ref" : "#/components/schemas/CameraMotorConfigType" }, "mounting_direction" : { "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "night_exposure_level" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_brightness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_contrast" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_saturation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_img_sharpness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_metering_config" : { "$ref" : "#/components/schemas/CameraMeteringConfigType" }, "night_sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "night_shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "object_search" : { "type" : "boolean", "nullable" : true }, "occupancy_count_high_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_count_low_threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "occupancy_counting" : { "type" : "boolean", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "people_tracking" : { "type" : "boolean", "nullable" : true }, "person_reidentification" : { "type" : "boolean", "nullable" : true }, "privacy_window_polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, "privacy_windows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PermyriadRect" }, "nullable" : true }, "ptz_config" : { "$ref" : "#/components/schemas/CameraPTZConfigType" }, "ptz_home" : { "$ref" : "#/components/schemas/CameraPtzHome" }, "record_on_motion" : { "type" : "boolean", "nullable" : true }, "region_for_occupancy" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest" : { "$ref" : "#/components/schemas/RegionConfigType" }, "region_of_interest_groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, "resolution" : { "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, "rotation" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rtsp_encoder" : { "type" : "integer", "format" : "int32", "nullable" : true }, "segment_max_bytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensor_gain_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shared_fov" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "shutter_time_max" : { "type" : "integer", "format" : "int32", "nullable" : true }, "shutter_time_min" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_height" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_interval_secs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "tile_views" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "upload_all_detections" : { "type" : "boolean", "nullable" : true }, "use_onboard_lpr" : { "type" : "boolean", "nullable" : true }, "vehicle_detection" : { "type" : "boolean", "nullable" : true }, "video_ai_disabled" : { "type" : "boolean", "nullable" : true }, "video_persist_disabled" : { "type" : "boolean", "nullable" : true }, "wdr_enabled" : { "type" : "boolean", "nullable" : true }, "wdr_strength" : { "type" : "integer", "format" : "int32", "nullable" : true }, "zero_motion_video_bitrate_percent" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Device_config_userconfig_IExternalUpdateableButtonUserConfig" : { "type" : "object", "description" : "Configuration update for the button sensor", "properties" : { "button_emergency_onsite_contact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "button_test_mode_enabled" : { "type" : "boolean", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" : { "type" : "object", "description" : "Configuration update for the door controller", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "autocomponentize_readers" : { "type" : "boolean", "nullable" : true }, "autoregister_readers" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "flip_display_orientation" : { "type" : "boolean", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "mdns_advertise_enabled" : { "type" : "boolean", "nullable" : true }, "mdns_discover_enabled" : { "type" : "boolean", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "peer_address_mode" : { "$ref" : "#/components/schemas/PeerAddressModeEnum" }, "peer_channel_mode" : { "$ref" : "#/components/schemas/PeerChannelModeEnum" }, "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_disabled" : { "type" : "boolean", "nullable" : true }, "proximity_sensor_tamper_distance_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" } } }, "Device_health_DisableDeviceHealthTrackingWSRequest" : { "type" : "object", "description" : "Request object for disabling device health tracking.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reEnableCondition" : { "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" } } }, "Device_health_DisableDeviceHealthTrackingWSResponse" : { "type" : "object", "description" : "Response object for disabling device health tracking." }, "Device_health_EnableDeviceHealthTrackingWSRequest" : { "type" : "object", "description" : "Request object for enabling device health tracking.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Device_health_EnableDeviceHealthTrackingWSResponse" : { "type" : "object", "description" : "Response object for enabling device health tracking." }, "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding devices with disabled health tracking." }, "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSResponse" : { "type" : "object", "description" : "Response object for finding devices with disabled health tracking.", "properties" : { "disabledHealthTrackingInfos" : { "type" : "array", "description" : "List of organization devices for which health tracking is disabled.", "items" : { "$ref" : "#/components/schemas/DeviceDisabledHealthTrackingInfo" }, "nullable" : true } } }, "Device_health_GetDeviceHealthTrackingWSRequest" : { "type" : "object", "description" : "Request object for getting device health tracking.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Device_health_GetDeviceHealthTrackingWSResponse" : { "type" : "object", "description" : "Response object for getting device health tracking.", "properties" : { "enabled" : { "type" : "boolean", "description" : "Whether device health tracking is currently enabled for this device.", "example" : true, "nullable" : true }, "reEnableCondition" : { "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" } } }, "Device_label_AddDeviceLabelWSRequest" : { "type" : "object", "description" : "Request object for adding a label to a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "description" : "Label to add to the device", "example" : "Maintenance", "nullable" : true } } }, "Device_label_AddDeviceLabelWSResponse" : { "type" : "object", "description" : "Response object for adding a label to a device." }, "Device_label_FindDeviceLabelsByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding device labels by organization." }, "Device_label_FindDeviceLabelsByOrgWSResponse" : { "type" : "object", "description" : "Response object containing device labels by organization.", "properties" : { "labelsByDevice" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of device UUIDs to their associated labels", "items" : { "type" : "string", "description" : "Map of device UUIDs to their associated labels", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "description" : "Map of device UUIDs to their associated labels", "nullable" : true } } }, "Device_label_RemoveDeviceLabelWSRequest" : { "type" : "object", "description" : "Request object for removing a label from a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "description" : "Label to remove from the device.", "example" : "Maintenance", "nullable" : true } } }, "Device_label_RemoveDeviceLabelWSResponse" : { "type" : "object", "description" : "Response object for removing a label from a device." }, "DewarpedView" : { "type" : "object", "properties" : { "aspectRatio" : { "$ref" : "#/components/schemas/AspectRatio" }, "pitchDegrees" : { "type" : "number", "format" : "float", "nullable" : true }, "rollDegrees" : { "type" : "number", "format" : "float", "nullable" : true }, "verticalFieldOfViewDegrees" : { "type" : "integer", "format" : "int32", "nullable" : true }, "yawDegrees" : { "type" : "number", "format" : "float", "nullable" : true } } }, "DiagnosticActivityEnum" : { "type" : "string", "enum" : [ "CAMERA_CONNECTED", "CAMERA_DISCONNECTED", "STARTUP", "GATEWAY_CONNECTED", "GATEWAY_DISCONNECTED", "UPDATE_STARTED", "UPDATE_FIRMWARE_DOWNLOADED", "UPDATE_FIRMWARE_APPLIED", "UPDATE_STARTING_REBOOT", "UPDATE_FAILED_MD5_MISMATCH", "UPDATE_FAILED_ACCESS_DENIED", "UPDATE_FAILED_MITM", "UPDATE_FAILED_CONNNECTION_REFUSED", "UPDATE_FAILED_CONNNECTION_TIMEOUT", "UPDATE_FAILED_CONNECTION_REFUSED", "UPDATE_FAILED_CONNECTION_TIMEOUT", "UPDATE_FAILED_DNS_FAILURE", "UPDATE_RUNNING", "UPDATE_HALTED_FOR_INVESTIGATION", "UPDATE_HALT_CLEARED", "UPDATE_HALT_STATE_ACTIVE", "UPDATE_REFUSED_HALTED", "BLE_CONNECTED", "BLE_CONNECTION_FAILED", "BLE_DISCONNECTED", "BLE_OP_SUCCESS", "BLE_OP_FAILURE", "UPLOAD_CLIP_SUCCESS", "UPLOAD_CLIP_FAILURE", "NOTIFICATION_FAILURE", "USB_FAILURE_REBOOT", "PERSISTENT_STORAGE_FAILURE", "PING", "FORCED_REBOOT", "AUTO_REBOOT", "AUDIO_HARDWARE_NOT_DETECTED", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "VIDEO_HARDWARE_FAILURE", "WIFI_NETWORK_CHANGED", "AI_ENGINE_DOWNLOADED", "AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH", "AI_ENGINE_CONFIGURED", "AI_ENGINE_CONFIGURATION_FAILED", "MITM_FAILURE", "SERVER_RECONNECT", "AP_CHANGED", "WATCHDOG_KILLED_AGENT", "WATCHDOG_DID_RESET", "CLIMATE_OFFLINE", "CLIMATE_ONLINE", "CLIMATE_LOW_BATTERY", "CLIMATE_PROBE_CONNECTED", "CLIMATE_PROBE_DISCONNECTED", "DOOR_OFFLINE", "DOOR_ONLINE", "DOOR_LOW_BATTERY", "OCCUPANCY_SENSOR_ONLINE", "OCCUPANCY_SENSOR_OFFLINE", "OCCUPANCY_SENSOR_LOW_BATTERY", "BUTTON_OFFLINE", "BUTTON_ONLINE", "BUTTON_LOW_BATTERY", "PROXIMITY_LOW_BATTERY", "ROBOT_LOW_BATTERY", "DOOR_CONTROLLER_CONNECTED", "DOOR_CONTROLLER_DISCONNECTED", "APERIO_LOW_BATTERY", "APERIO_FLAT_BATTERY", "APERIO_OK_BATTERY", "APERIO_GW_CONNECTED", "APERIO_GW_DISCONNECTED", "SCHLAGE_LOW_BATTERY", "SCHLAGE_CRITICAL_BATTERY", "SCHLAGE_OK_BATTERY", "SCHLAGE_GW_CONNECTED", "SCHLAGE_GW_DISCONNECTED", "SCHLAGE_APM_CONNECTED", "SCHLAGE_APM_DISCONNECTED", "BADGE_READER_CONNECTED", "BADGE_READER_DISCONNECTED", "REBOOT", "NETWORK_INTERRUPTION", "OPENPATH_WEBHOOK_FAILURE", "TOAST_WEBHOOK_FAILURE", "KISI_WEBHOOK_FAILURE", "BRIVO_WEBHOOK_FAILURE", "HALO_WEBHOOK_FAILURE", "SALTO_WEBHOOK_FAILURE", "SQUARE_WEBHOOK_FAILURE", "BUTTERFLYMX_WEBHOOK_FAILURE", "ENVOY_WEBHOOK_FAILURE", "GENEA_WEBHOOK_FAILURE", "PRODATAKEY_WEBHOOK_FAILURE", "AMT_WEBHOOK_FAILURE", "PLACEOS_WEBHOOK_FAILURE", "OMNIALERT_WEBHOOK_FAILURE", "FLIC_WEBHOOK_FAILURE", "SHELLY_WEBHOOK_FAILURE", "PIMLOC_WEBHOOK_FAILURE", "NINEONEONECELLULAR_WEBHOOK_FAILURE", "HONEYWELL_ELEMENTS_WEBHOOK_FAILURE", "HONEYWELL_ONGUARD_WEBHOOK_FAILURE", "TRITON_WEBHOOK_FAILURE", "EXTERNAL_WEBHOOK_FAILURE", "VOICE_CALL_INITIATED", "VOICE_CALL_ANSWERED", "VOICE_CALL_REJECTED_AS_MACHINE", "VOICE_CALL_COMPLETED", "VOICE_CALL_NO_ANSWER", "VOICE_CALL_FAILED", "VOICE_CALL_SKIPPED", "CV_FAILURE", "NFC_HW_FAILURE", "CONFIG_ERROR", "HW_FAILURE", "BLE_HW_RECOVERED", "BLE_HW_FAILURE", "KEYPAD_ONLINE", "KEYPAD_OFFLINE", "ALM_OVERAGE_APPROACHING", "ALM_OVERAGE_REACHED", "ALM_OVERAGE_EXCEEDED", "ALM_EXCESSIVE_VERIFICATIONS", "KIOSK_OFFLINE", "KIOSK_ONLINE", "TUNNELED_DEVICE_CONNECTED", "TUNNELED_DEVICE_DISCONNECTED", "SD_CARD_CHANGED", "SD_CARD_NOT_FOUND", "SUPERVISION_CUT_DETECTED", "SUPERVISION_SHORT_DETECTED", "SUPERVISION_INVALID_SETUP", "THIRD_PARTY_DEVICE_CONNECTED", "THIRD_PARTY_DEVICE_DISCONNECTED", "NVR_STREAMING_STATUS", "STORAGE_SM", "DEVICE_OFFLINE_EXTENDED", "DEVICE_OFFLINE_RECOVERED", "DEVICES_OFFLINE_THRESHOLD", "CLOUD_ARCHIVE_LAGGING", "CLOUD_ARCHIVE_RECOVERED", "LOCAL_RECORDING_INTERRUPTED", "LOCAL_RECORDING_RECOVERED", "UNKNOWN" ] }, "DiagnosticEventType" : { "type" : "object", "description" : "List of diagnostic events", "properties" : { "activity" : { "$ref" : "#/components/schemas/DiagnosticActivityEnum" }, "apMac" : { "type" : "string", "nullable" : true }, "asi" : { "type" : "string", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "connectionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "deviceName" : { "type" : "string", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportingDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "timestamp" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DiagnosticRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deviceLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "diagnosticEvent" : { "$ref" : "#/components/schemas/SimpleDiagnosticEventType" }, "locationUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "DiceSettings" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DiceType" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DisarmMonitoringRule" : { "type" : "object", "description" : "Rule used to manually disarm scheduled alarm policies while the monitoring mode is set to scheduled.\n", "properties" : { "activeAfterMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX timestamp (in milliseconds) when this rule will go into effect.", "nullable" : true }, "disarmAllUntilMs" : { "type" : "integer", "format" : "int64", "description" : "The UNIX timestamp (in milliseconds) to pause all alarm policies until.", "nullable" : true }, "disarmedAlarmPolicies" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", "nullable" : true }, "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", "nullable" : true } } }, "DiscoveredThirdPartyCameraType" : { "type" : "object", "description" : "The imported (discovered) third-party camera. This field is populated only if the RTSP URL specified in the import resulted in creation of a new discovery or an addition of a RTSP URL to an existing discovery. It is null, if the RTSP URL already existed or if the import was not successful.", "properties" : { "codec" : { "type" : "string", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "ipAddress" : { "type" : "string", "nullable" : true }, "lastVisibleMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "macAddress" : { "type" : "string", "nullable" : true }, "manufacturer" : { "type" : "string", "nullable" : true }, "model" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "onvifPassword" : { "type" : "string", "nullable" : true }, "onvifProfileToken" : { "type" : "string", "nullable" : true }, "onvifUsername" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "rtspEndpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RtspEndpoint" }, "nullable" : true, "uniqueItems" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "username" : { "type" : "string", "nullable" : true } } }, "DoorAjarActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "doorAjarThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "DoorAuthFirstInStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "acuEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "source" : { "$ref" : "#/components/schemas/FirstInSourceEnum" }, "stateChangedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorEventType" : { "type" : "object", "description" : "List of door open/close events for the sensor", "properties" : { "baseStationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "batteryPercentage" : { "type" : "integer", "format" : "int32", "nullable" : true }, "bleDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "bleRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "closeBaseStations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/DoorStateEnum" }, "stateChanged" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DoorFirstInStateChangeEventReference" : { "type" : "object", "nullable" : true, "properties" : { "doorUuidToEventUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, "originatingDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originatingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "source" : { "$ref" : "#/components/schemas/FirstInSourceEnum" }, "stateChangedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DoorLocationLockdownStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatedLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "activeLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "acuEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deactivatedLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationLockdownStateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorLockdownStateEnumType" : { "type" : "string", "enum" : [ "LOCKED_DOWN", "ACCESS_CONTROLLED", "UNLOCKED", "UNKNOWN" ] }, "DoorLockdownStateEventReference" : { "type" : "object", "nullable" : true, "properties" : { "activatedLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "activeLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "deactivatedLockdownPlan" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "doorEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorPolicyType" : { "type" : "object", "description" : "List of door sensor policies using the schedule", "properties" : { "defaultAjarThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "defaultTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorPositionIndicatorEnumType" : { "type" : "string", "enum" : [ "integrated", "remote" ] }, "DoorPositionIndicatorPhysicalPortEnumType" : { "type" : "string", "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] }, "DoorPositionIndicatorPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/DoorPositionIndicatorPhysicalPortEnumType" }, "supervisionConfiguration" : { "$ref" : "#/components/schemas/PortSupervisionConfigurationType" } } }, "DoorPositionIndicatorShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "state" : { "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "supervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DoorPositionIndicatorStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" }, "newSupervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorPositionIndicatorStateEnumType" : { "type" : "string", "enum" : [ "OPEN", "CLOSED", "AJAR", "FORCED_OPEN", "ERROR", "UNKNOWN" ] }, "DoorReaderEnumType" : { "type" : "string", "enum" : [ "wiegand", "osdp", "rhombus_osdp", "aperio_wireless", "aperio_rs485", "schlage_wireless", "schlage_rs485" ] }, "DoorReaderSettings" : { "type" : "object", "properties" : { "dr_enable_audio_feedback" : { "type" : "boolean", "nullable" : true }, "tof_max_distance" : { "type" : "number", "format" : "float", "nullable" : true }, "tof_min_distance" : { "type" : "number", "format" : "float", "nullable" : true }, "tof_min_signal_over_noise" : { "type" : "number", "format" : "float", "nullable" : true } } }, "DoorReaderSettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Door Reader settings", "properties" : { "dr_enable_audio_feedback" : { "type" : "boolean", "nullable" : true }, "tof_max_distance" : { "type" : "number", "format" : "float", "nullable" : true }, "tof_min_distance" : { "type" : "number", "format" : "float", "nullable" : true }, "tof_min_signal_over_noise" : { "type" : "number", "format" : "float", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "DoorReaderShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "state" : { "$ref" : "#/components/schemas/DoorReaderStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DoorReaderStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/DoorReaderStateEnumType" }, "reason" : { "$ref" : "#/components/schemas/DoorReaderStateChangeReasonEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorReaderStateChangeReasonEnumType" : { "type" : "string", "enum" : [ "FIRMWARE_UPGRADE", "FORCED_REBOOT", "UNKNOWN" ] }, "DoorReaderStateEnumType" : { "type" : "string", "enum" : [ "CONNECTED", "DISCONNECTED", "UNKNOWN" ] }, "DoorRelayEnumType" : { "type" : "string", "enum" : [ "integrated", "remote" ] }, "DoorRelayPhysicalPortEnumType" : { "type" : "string", "enum" : [ "GPIO_OUTPUT" ] }, "DoorRelayPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/DoorRelayPhysicalPortEnumType" } } }, "DoorRelayShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "state" : { "$ref" : "#/components/schemas/DoorRelayStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DoorRelayStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/DoorRelayStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorRelayStateEnumType" : { "type" : "string", "enum" : [ "UNLOCKED", "LOCKED", "UNKNOWN" ] }, "DoorScheduleExceptionType" : { "type" : "object", "description" : "The door schedule exception to update.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "UNIX timestamp in milliseconds when exception was created.", "nullable" : true, "readOnly" : true }, "defaultState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "description" : { "type" : "string", "description" : "Exception description", "nullable" : true }, "doorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "intervals" : { "type" : "array", "description" : "List of intervals each specifying door state during date range. List must contain at least one element", "items" : { "$ref" : "#/components/schemas/LocalInterval" }, "nullable" : true }, "localEndDate" : { "type" : "string", "description" : "Exception end date in 'yyyy-MM-dd' format. End date is inclusive.", "nullable" : true }, "localStartDate" : { "type" : "string", "description" : "Exception start date in 'yyyy-MM-dd' format. Start date is inclusive.", "nullable" : true }, "locationToDoorsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Exception name", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "UNIX timestamp in milliseconds when exception was modified.", "nullable" : true, "readOnly" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "intervals", "localEndDate", "localStartDate", "name" ] }, "DoorScheduleFirstInStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "acuEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "source" : { "$ref" : "#/components/schemas/FirstInSourceEnum" }, "stateChangedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorScheduledTriggerType" : { "type" : "object", "properties" : { "ajarThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true } } }, "DoorSensorSettings" : { "type" : "object", "properties" : { "ajar_threshold_enabled" : { "type" : "boolean", "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", "nullable" : true }, "ajar_threshold_sec" : { "type" : "integer", "format" : "int32", "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", "nullable" : true } } }, "DoorSensorSettingsSelectiveUpdate" : { "type" : "object", "properties" : { "ajar_threshold_enabled" : { "type" : "boolean", "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", "nullable" : true }, "ajar_threshold_sec" : { "type" : "integer", "format" : "int32", "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "DoorStateChangeEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "source" : { "$ref" : "#/components/schemas/AccessStateSourceEnum" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DoorStateEnum" : { "type" : "string", "description" : "Filter events by door state", "enum" : [ "OPEN", "CLOSED", "AJAR" ] }, "DoorStatusEnum" : { "type" : "string", "description" : "Door state for door sensor webhooks", "enum" : [ "OPEN", "CLOSED", "AJAR" ] }, "DoorType" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "Door_DoorHealthDetailsEnum" : { "type" : "string", "description" : "Enumeration of specific health details for door sensors.", "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] }, "Door_DoorHealthEnum" : { "type" : "string", "description" : "Enumeration of health status for door sensors.", "enum" : [ "GREEN", "RED" ] }, "Door_GetDoorEventsForSensorWSRequest" : { "type" : "object", "description" : "Request object for retrieving door open/close events for a door sensor.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds to get events created after this time", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds to get events created before this time", "example" : 1640995200000, "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of events to return", "example" : 100, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "stateChangedOnly" : { "type" : "boolean", "description" : "When true, only return events where the door state actually changed (open/close transitions), excluding the periodic heartbeat events that report an unchanged state", "nullable" : true }, "stateFilter" : { "$ref" : "#/components/schemas/DoorStateEnum" } } }, "Door_GetDoorEventsForSensorWSResponse" : { "type" : "object", "description" : "Response object containing door open/close events for a door sensor.", "properties" : { "doorEvents" : { "type" : "array", "description" : "List of door open/close events for the sensor", "items" : { "$ref" : "#/components/schemas/DoorEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Door_GetMinimalDoorStatesWSRequest" : { "type" : "object", "description" : "Request object for retrieving basic state information for all door sensors." }, "Door_GetMinimalDoorStatesWSResponse" : { "type" : "object", "description" : "Response object containing basic state information for all door sensors.", "properties" : { "doorStates" : { "type" : "array", "description" : "List of minimal door state information for all door sensors", "items" : { "$ref" : "#/components/schemas/Door_MinimalDoorStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Door_MinimalDoorStateType" : { "type" : "object", "description" : "Minimal state information for a door sensor.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "batteryPercent" : { "type" : "integer", "format" : "int32", "description" : "Battery percentage of the door sensor", "example" : 75, "nullable" : true }, "closestBaseStation" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds when the door sensor was created", "example" : 1640995200000, "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version of the door sensor", "example" : "1.2.3", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the door sensor is located", "example" : 1, "nullable" : true }, "health" : { "$ref" : "#/components/schemas/Door_DoorHealthEnum" }, "healthDetails" : { "$ref" : "#/components/schemas/Door_DoorHealthDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lastSeenSec" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in seconds when the door sensor was last seen", "example" : 1640995200, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the door sensor", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the door sensor", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the door sensor", "example" : "Main Entrance Door", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the door sensor", "example" : "DS123456789", "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the door sensor", "example" : 85, "nullable" : true }, "status" : { "$ref" : "#/components/schemas/DoorStatusEnum" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "Door_UpdateDoorSensorDetailsWSRequest" : { "type" : "object", "description" : "Request object for updating details for a door sensor.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "associatedCamerasUpdated" : { "type" : "boolean", "description" : "Whether the associated cameras have been updated", "example" : true, "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the door sensor is deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "description" : "Whether the deleted status has been updated", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the door sensor", "example" : "Main entrance door sensor on the first floor", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "description" : "Whether the description has been updated", "example" : false, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the door sensor is located", "example" : 1, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "description" : "Whether the floor number has been updated", "example" : true, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the door sensor", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "description" : "Whether the latitude has been updated", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "description" : "Whether the location UUID has been updated", "example" : true, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the door sensor", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "description" : "Whether the longitude has been updated", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the door sensor", "example" : "Main Entrance Door", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "description" : "Whether the name has been updated", "example" : true, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "description" : "Whether the policy UUID has been updated", "example" : false, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Door_UpdateDoorSensorDetailsWSResponse" : { "type" : "object", "description" : "Response object for updating details for a door sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "DoorbellEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newSupervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorbellcamera_CreateRuleForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for creating a rule for a doorbell camera.", "properties" : { "rule" : { "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" } } }, "Doorbellcamera_CreateRuleForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object for creating a rule for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_CreateSharedLiveVideoStreamWSRequest" : { "type" : "object", "description" : "Request object for creating a shared live video stream for a doorbell camera.", "properties" : { "audioGatewayUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "doorbellCameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "expirationTimeSecs" : { "type" : "integer", "format" : "int32", "description" : "Add a expiration date for accessing the stream in seconds", "example" : 86400, "nullable" : true }, "invertSchedule" : { "type" : "boolean", "description" : "If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "If not provided, will be named 'Unnamed'", "example" : "Front Door Stream", "nullable" : true }, "password" : { "type" : "string", "description" : "Add a password to allow access to your shared stream. If null or blank password is not set.", "example" : "mypassword123", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "streamType" : { "$ref" : "#/components/schemas/StreamTypeEnum" }, "vodEnabled" : { "type" : "boolean", "description" : "Enables recording of live footage to a VOD", "example" : true, "nullable" : true } }, "required" : [ "doorbellCameraUuid", "streamType", "vodEnabled" ] }, "Doorbellcamera_CreateSharedLiveVideoStreamWSResponse" : { "type" : "object", "description" : "Response object for creating a shared live video stream for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveM3U8StreamUrl" : { "type" : "string", "description" : "M3U8 URL for the shared live video stream", "example" : "https://example.com/live/m3u8/stream", "nullable" : true }, "sharedLiveVideoStreamUrl" : { "type" : "string", "description" : "URL for the shared live video stream", "example" : "https://example.com/live/video/stream", "nullable" : true }, "sharedLiveVideoStreamUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_DeleteDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for removing a doorbell camera from the organization.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Whether to mummify the doorbell camera", "example" : false, "nullable" : true } }, "required" : [ "doorbellCameraUuid", "mummify" ] }, "Doorbellcamera_DeleteDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object for removing a doorbell camera from the organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for deleting a rule for a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object for deleting a rule for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" : { "type" : "object", "description" : "Information for offline LAN streaming of doorbell camera content.", "properties" : { "accessToken" : { "type" : "string", "description" : "Access token for offline LAN streaming", "example" : "abc123def456", "nullable" : true }, "lanAddresses" : { "type" : "array", "description" : "List of LAN addresses for offline streaming", "items" : { "type" : "string", "description" : "List of LAN addresses for offline streaming", "nullable" : true }, "nullable" : true } } }, "Doorbellcamera_DoorbellRingReadinessReasonEnum" : { "type" : "string", "description" : "Why the recipient cannot be rung, null when they can", "enum" : [ "NOT_ORG_MEMBER", "NO_APP_SESSION", "NO_VOIP_DEVICE" ] }, "Doorbellcamera_DoorbellRingRecipientReadinessType" : { "type" : "object", "description" : "VoIP-ring reachability for one configured doorbell recipient.", "properties" : { "canReceiveVoip" : { "type" : "boolean", "description" : "Whether a VoIP-capable device can be rung for this recipient", "nullable" : true }, "name" : { "type" : "string", "description" : "Display name of the recipient, null when the recipient is not an org member", "nullable" : true }, "reason" : { "$ref" : "#/components/schemas/Doorbellcamera_DoorbellRingReadinessReasonEnum" }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorbellcamera_ExternalDoorbellCameraComponentRuleType" : { "type" : "object", "description" : "External representation of a doorbell camera component rule.", "properties" : { "action" : { "$ref" : "#/components/schemas/RuleActionType" }, "doorbellCameraComponentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleFilters" : { "$ref" : "#/components/schemas/RuleFilterType" }, "ruleName" : { "type" : "string", "description" : "Name of the rule", "example" : "Motion Detection Rule", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "triggerActivity" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for retrieving component events for a doorbell camera.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", "example" : 1640995200000, "nullable" : true }, "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Limits the number of returned events to the latest LIMIT events. Maximum value is 100.", "example" : 50, "nullable" : true }, "typeFilter" : { "type" : "array", "description" : "Limits results to only contain the specified type of events, if applicable", "items" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } }, "required" : [ "doorbellCameraUuid", "limit" ] }, "Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object containing component events for a doorbell camera.", "properties" : { "componentEvents" : { "type" : "array", "description" : "List of component events for the doorbell camera", "items" : { "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for retrieving component seekpoints for a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds for the seekpoint query", "example" : 3600, "nullable" : true }, "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds epoch (exclusive) for the seekpoint query", "example" : 1640995200, "nullable" : true } } }, "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object containing component seekpoints for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "seekpoints" : { "type" : "array", "description" : "List of component seekpoints for the doorbell camera", "items" : { "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest" : { "type" : "object", "description" : "Request object for finding shared live video streams for a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Doorbellcamera_FindSharedLiveVideoStreamsWSResponse" : { "type" : "object", "description" : "Response object containing shared live video streams for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedLiveVideoStreams" : { "type" : "array", "description" : "List of shared live video streams for the doorbell camera", "items" : { "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_GetDoorbellCameraConfigWSResponse" : { "type" : "object", "description" : "Response object containing doorbell camera configuration.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_GetDoorbellCameraFullStateWSResponse" : { "type" : "object", "description" : "Response object containing detailed state information for a doorbell camera.", "properties" : { "fullState" : { "$ref" : "#/components/schemas/FullDeviceStateType" } } }, "Doorbellcamera_GetDoorbellCameraMediaUrisWSResponse" : { "type" : "object", "description" : "Response object containing media URIs for doorbell camera footage and audio.", "properties" : { "lanCheckUrls" : { "type" : "array", "description" : "List of LAN check URLs to verify device availability on local network", "items" : { "type" : "string", "description" : "List of LAN check URLs to verify device availability on local network", "nullable" : true }, "nullable" : true }, "lanLiveH264Uris" : { "type" : "array", "description" : "List of LAN URIs for live H.264 video streams", "items" : { "type" : "string", "description" : "List of LAN URIs for live H.264 video streams", "nullable" : true }, "nullable" : true }, "lanLiveMpdUris" : { "type" : "array", "description" : "List of LAN URIs for live MPD streams", "items" : { "type" : "string", "description" : "List of LAN URIs for live MPD streams", "nullable" : true }, "nullable" : true }, "lanLiveOpusUris" : { "type" : "array", "description" : "List of LAN URIs for live Opus audio streams", "items" : { "type" : "string", "description" : "List of LAN URIs for live Opus audio streams", "nullable" : true }, "nullable" : true }, "lanVodM3u8UrisTemplates" : { "type" : "array", "description" : "List of LAN URI templates for VOD M3U8 streams", "items" : { "type" : "string", "description" : "List of LAN URI templates for VOD M3U8 streams", "nullable" : true }, "nullable" : true }, "lanVodMpdUrisTemplates" : { "type" : "array", "description" : "List of LAN URI templates for VOD MPD streams", "items" : { "type" : "string", "description" : "List of LAN URI templates for VOD MPD streams", "nullable" : true }, "nullable" : true }, "wanLiveH264Uri" : { "type" : "string", "description" : "WAN URI for live H.264 video stream", "nullable" : true }, "wanLiveMpdUri" : { "type" : "string", "description" : "WAN URI for live MPD stream", "nullable" : true }, "wanLiveOpusUri" : { "type" : "string", "description" : "WAN URI for live Opus audio stream", "nullable" : true }, "wanVodM3u8UriTemplate" : { "type" : "string", "description" : "WAN URI template for VOD M3U8 streams", "nullable" : true }, "wanVodMpdUriTemplate" : { "type" : "string", "description" : "WAN URI template for VOD MPD streams", "nullable" : true } } }, "Doorbellcamera_GetDoorbellCameraMinimalStateListWSResponse" : { "type" : "object", "description" : "Response object containing basic state information for all doorbell cameras.", "properties" : { "minimalStates" : { "type" : "array", "description" : "List of minimal state information for doorbell cameras", "items" : { "$ref" : "#/components/schemas/MinimalObservableDeviceStateType" }, "nullable" : true } } }, "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSRequest" : { "type" : "object", "description" : "Request object for retrieving offline LAN streaming information for doorbell cameras." }, "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSResponse" : { "type" : "object", "description" : "Response object containing offline LAN streaming information for doorbell cameras.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "info" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" }, "description" : "Map of doorbell camera UUIDs to their offline LAN streaming information", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest" : { "type" : "object", "description" : "Request object for retrieving rules for all doorbell cameras in an organization." }, "Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse" : { "type" : "object", "description" : "Response object containing rules for all doorbell cameras in an organization.", "properties" : { "doorbellCameraUuidToRulesMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of doorbell camera UUIDs to their component rules", "items" : { "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" }, "nullable" : true }, "description" : "Map of doorbell camera UUIDs to their component rules", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_GetMobileRingReadinessForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for retrieving mobile-ring readiness for a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorbellcamera_GetMobileRingReadinessForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object containing per-recipient mobile-ring readiness for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "recipients" : { "type" : "array", "description" : "Readiness of every recipient configured on the doorbell camera's ring rules", "items" : { "$ref" : "#/components/schemas/Doorbellcamera_DoorbellRingRecipientReadinessType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_GetRulesForDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for retrieving all rules for a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorbellcamera_GetRulesForDoorbellCameraWSResponse" : { "type" : "object", "description" : "Response object containing all rules for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of component rules for the doorbell camera", "items" : { "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_RebootDoorbellCameraWSRequest" : { "type" : "object", "description" : "Request object for rebooting a doorbell camera.", "properties" : { "doorbellCameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "doorbellCameraUuid" ] }, "Doorbellcamera_ReportTalkSessionWSRequest" : { "type" : "object", "description" : "Request object for reporting an operator talk session on a video intercom.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/IntercomTalkStateEnumType" }, "talkSessionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "deviceUuid", "state", "talkSessionUuid" ] }, "Doorbellcamera_ReportTalkSessionWSResponse" : { "type" : "object", "description" : "Response object for reporting an operator talk session on a video intercom.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorbellcamera_UpdateDoorbellCameraConfigWSRequest" : { "type" : "object", "description" : "Request object for updating doorbell camera configuration.", "properties" : { "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" } } }, "Doorbellcamera_UpdateDoorbellCameraDetailsWSRequest" : { "type" : "object", "description" : "Request object for updating hardware details of a doorbell camera.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "Optional list of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "description" : { "type" : "string", "description" : "Optional description for the doorbell camera", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "description" : "Optional direction in radians for the doorbell camera", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Optional floor number where the doorbell camera is located", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Optional latitude coordinate of the doorbell camera", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Optional longitude coordinate of the doorbell camera", "nullable" : true }, "name" : { "type" : "string", "description" : "Optional name for the doorbell camera", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true } } }, "Doorcontroller_CreateDoorControllerRuleWSRequest" : { "type" : "object", "description" : "Request object for creating a rule owned by a door controller.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rule" : { "$ref" : "#/components/schemas/RuleType" } } }, "Doorcontroller_CreateDoorControllerRuleWSResponse" : { "type" : "object", "description" : "Response object for creating a rule owned by a door controller.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rule" : { "$ref" : "#/components/schemas/RuleType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_DeleteDoorControllerRuleWSRequest" : { "type" : "object", "description" : "Request object for deleting a rule owned by a door controller.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorcontroller_DeleteDoorControllerRuleWSResponse" : { "type" : "object", "description" : "Response object for deleting a rule owned by a door controller." }, "Doorcontroller_DeleteDoorControllerWSRequest" : { "type" : "object", "description" : "Request object for removing a door controller from the organization.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mummify" : { "type" : "boolean", "description" : "Whether to mummify the door controller", "example" : false, "nullable" : true } }, "required" : [ "doorControllerUuid", "mummify" ] }, "Doorcontroller_DeleteDoorControllerWSResponse" : { "type" : "object", "description" : "Response object for removing a door controller from the organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_DoorControllerDiscoveredAperioDoor" : { "type" : "object", "description" : "Discovered Aperio door device information.", "properties" : { "gatewayId" : { "type" : "string", "description" : "Identifier for the associated Aperio gateway", "example" : "gateway_67890", "nullable" : true }, "id" : { "type" : "string", "description" : "Unique identifier for the Aperio door", "example" : "door_12345", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the door was last seen", "example" : 1640995200000, "nullable" : true } } }, "Doorcontroller_DoorControllerDiscoveredAperioGateway" : { "type" : "object", "description" : "Discovered Aperio gateway device information.", "properties" : { "id" : { "type" : "string", "description" : "Unique identifier for the Aperio gateway", "example" : "gateway_12345", "nullable" : true }, "ipAddress" : { "type" : "string", "description" : "IP address of the Aperio gateway", "example" : "192.168.1.100", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the gateway was last seen", "example" : 1640995200000, "nullable" : true }, "model" : { "type" : "string", "description" : "Model of the Aperio gateway", "example" : "AH-GW-01", "nullable" : true }, "protocolVersion" : { "type" : "string", "description" : "Protocol version of the Aperio gateway", "example" : "2.1", "nullable" : true } } }, "Doorcontroller_DoorControllerDiscoveredReaderType" : { "type" : "object", "description" : "List of discovered readers", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredRhombusReaderType" }, { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" } ], "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number for the reader connection", "example" : 1, "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the reader was last seen", "example" : 1640995200000, "nullable" : true }, "online" : { "type" : "boolean", "description" : "Whether the reader is currently online", "example" : true, "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number for the reader connection", "example" : 0, "nullable" : true }, "type" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" } } }, "Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" : { "type" : "string", "description" : "Enumeration of discovered reader types.", "enum" : [ "RHOMBUS", "THIRD_PARTY" ] }, "Doorcontroller_DoorControllerDiscoveredRhombusReaderType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "description" : "Serial number of the Rhombus reader", "example" : "RR-12345678", "nullable" : true } } } ], "description" : "Discovered Rhombus reader information.", "nullable" : true, "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number for the reader connection", "example" : 1, "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the reader was last seen", "example" : 1640995200000, "nullable" : true }, "online" : { "type" : "boolean", "description" : "Whether the reader is currently online", "example" : true, "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number for the reader connection", "example" : 0, "nullable" : true }, "type" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" } } }, "Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "model" : { "type" : "string", "format" : "byte", "description" : "Model identifier for the third-party reader", "example" : "MQ==", "nullable" : true }, "serialNumber" : { "type" : "integer", "format" : "int32", "description" : "Serial number of the third-party reader", "example" : 12345, "nullable" : true }, "vendorCode" : { "type" : "array", "description" : "Vendor code for the third-party reader", "items" : { "type" : "string", "format" : "byte", "description" : "Vendor code for the third-party reader", "nullable" : true }, "nullable" : true } } } ], "description" : "Discovered third-party reader information.", "nullable" : true, "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number for the reader connection", "example" : 1, "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the reader was last seen", "example" : 1640995200000, "nullable" : true }, "online" : { "type" : "boolean", "description" : "Whether the reader is currently online", "example" : true, "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number for the reader connection", "example" : 0, "nullable" : true }, "type" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" } } }, "Doorcontroller_DoorControllerStateType" : { "type" : "object", "description" : "State information for a door controller including discovered devices and configuration.", "properties" : { "configUpdatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when configuration was last updated", "example" : 1640995200000, "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "defaultInterface" : { "type" : "string", "description" : "Default network interface of the door controller", "example" : "eth0", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "description" : "MAC address of the default interface", "example" : "00:11:22:33:44:55", "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the door controller is deleted", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the door controller", "example" : "Controls access to the main entrance", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "description" : "Direction in radians for the door controller", "example" : 1.5708, "nullable" : true }, "discoveredAperioDoors" : { "type" : "array", "description" : "List of discovered Aperio doors", "items" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioDoor" }, "nullable" : true }, "discoveredAperioGateways" : { "type" : "array", "description" : "List of discovered Aperio gateways", "items" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioGateway" }, "nullable" : true }, "discoveredReaders" : { "type" : "array", "description" : "List of discovered readers", "items" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderType" }, "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version of the door controller", "example" : "2.1.0", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the door controller is located", "example" : 1, "nullable" : true }, "grantsUpdatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when grants were last updated", "example" : 1640995200000, "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "description" : "List of LAN addresses for the door controller", "items" : { "type" : "string", "description" : "List of LAN addresses for the door controller", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the door controller", "example" : 34.0522, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the door controller", "example" : -118.2437, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the door controller", "example" : "Main Entrance Controller", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the door controller", "example" : "DC-12345678", "nullable" : true }, "state" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "State information for the door controller", "nullable" : true }, "description" : "State information for the door controller", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wanAddress" : { "type" : "string", "description" : "WAN address of the door controller", "example" : "203.0.113.1", "nullable" : true } } }, "Doorcontroller_GetDoorControllerConfigWSResponse" : { "type" : "object", "description" : "Response object containing door controller configuration.", "properties" : { "config" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableDoorControllerUserConfig" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_GetDoorControllerRuleWSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific rule owned by a door controller.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorcontroller_GetDoorControllerRuleWSResponse" : { "type" : "object", "description" : "Response object containing a specific rule owned by a door controller.", "properties" : { "rule" : { "$ref" : "#/components/schemas/RuleType" } } }, "Doorcontroller_GetDoorControllerRulesWSRequest" : { "type" : "object", "description" : "Request object for retrieving all rules owned by a door controller.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorcontroller_GetDoorControllerRulesWSResponse" : { "type" : "object", "description" : "Response object containing all rules owned by a door controller.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of rules owned by the door controller", "items" : { "$ref" : "#/components/schemas/RuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_GetDoorControllerStateListWSRequest" : { "type" : "object", "description" : "Request object for retrieving state information for all door controllers in an organization." }, "Doorcontroller_GetDoorControllerStateListWSResponse" : { "type" : "object", "description" : "Response object containing state information for all door controllers in an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "stateList" : { "type" : "array", "description" : "List of door controller state information", "items" : { "$ref" : "#/components/schemas/Doorcontroller_DoorControllerStateType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_RegisterDiscoveredRhombusReaderWSRequest" : { "type" : "object", "description" : "Request object for registering a Rhombus reader discovered by a door controller.", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number for the reader connection", "example" : 1, "nullable" : true }, "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number for the reader connection", "example" : 0, "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the discovered Rhombus reader", "example" : "RR-12345678", "nullable" : true } } }, "Doorcontroller_RegisterDiscoveredRhombusReaderWSResponse" : { "type" : "object", "description" : "Response object for registering a Rhombus reader discovered by a door controller." }, "Doorcontroller_UpdateDoorControllerConfigWSRequest" : { "type" : "object", "description" : "Request object for updating door controller configuration.", "properties" : { "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" } } }, "Doorcontroller_UpdateDoorControllerDetailsWSRequest" : { "type" : "object", "description" : "Request object for updating details for a door controller.", "properties" : { "description" : { "type" : "string", "description" : "Description of the door controller", "example" : "Controls access to the main entrance", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "description" : "Direction in radians for the door controller", "example" : 1.5708, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the door controller is located", "example" : 1, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the door controller", "example" : 34.0522, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the door controller", "example" : -118.2437, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the door controller", "example" : "Main Entrance Controller", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Doorcontroller_UpdateDoorControllerDetailsWSResponse" : { "type" : "object", "description" : "Response object for updating details for a door controller.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorcontroller_UpdateDoorControllerRuleWSRequest" : { "type" : "object", "description" : "Request object for updating a rule owned by a door controller.", "properties" : { "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rule" : { "$ref" : "#/components/schemas/RuleType" } } }, "Doorcontroller_UpdateDoorControllerRuleWSResponse" : { "type" : "object", "description" : "Response object for updating a rule owned by a door controller.", "properties" : { "rule" : { "$ref" : "#/components/schemas/RuleType" } } }, "Doorstation_AnswerDoorStationCallWSRequest" : { "type" : "object", "description" : "Request for the calling door station to answer (claim) a ringing doorbell call.", "properties" : { "callUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Doorstation_AnswerDoorStationCallWSResponse" : { "type" : "object", "description" : "Outcome of a door station's attempt to answer a doorbell call.", "properties" : { "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "result" : { "$ref" : "#/components/schemas/RingClaimResultEnum" } } }, "Doorstation_GetCurrentDoorStationWSRequest" : { "type" : "object", "description" : "Request object for getting the calling door station's own registration information." }, "Doorstation_GetCurrentDoorStationWSResponse" : { "type" : "object", "description" : "Response object containing the calling door station's own registration information.", "properties" : { "away" : { "type" : "boolean", "description" : "Whether this door station is in away mode, so it does not ring for doorbell presses. Absent if the door station's settings could not be loaded.", "nullable" : true }, "displayName" : { "type" : "string", "description" : "Current display name of this door station, as set in the console", "example" : "Front Lobby Door Station", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuids" : { "type" : "array", "description" : "Video walls assigned to this door station. Absent if the door station's settings could not be loaded.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorstation_GetDoorStationWSRequest" : { "type" : "object", "description" : "Request object for getting a door station's settings.", "properties" : { "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "tokenUuid" ] }, "Doorstation_GetDoorStationWSResponse" : { "type" : "object", "description" : "A door station's settings.", "properties" : { "away" : { "type" : "boolean", "description" : "Whether the door station is in away mode, so it does not ring for doorbell presses. Only the door station itself can change this.", "nullable" : true }, "displayName" : { "type" : "string", "description" : "Display name of the door station", "example" : "Front Lobby Door Station", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuids" : { "type" : "array", "description" : "Video walls assigned to this door station", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorstation_UnregisterDoorStationWSRequest" : { "type" : "object", "description" : "Request object for the calling door station to remove itself from its organization." }, "Doorstation_UnregisterDoorStationWSResponse" : { "type" : "object", "description" : "Response object for a door station removing itself from its organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorstation_UpdateCurrentDoorStationAwayWSRequest" : { "type" : "object", "description" : "Request object for the calling door station to turn its own away mode on or off.", "properties" : { "away" : { "type" : "boolean", "description" : "True to go away, so this door station stops ringing for doorbell presses; false to return", "nullable" : true } }, "required" : [ "away" ] }, "Doorstation_UpdateCurrentDoorStationAwayWSResponse" : { "type" : "object", "description" : "Response object for a door station turning its own away mode on or off.", "properties" : { "away" : { "type" : "boolean", "description" : "Whether this door station is now away. Absent on error.", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorstation_UpdateDoorStationLocationWSRequest" : { "type" : "object", "description" : "Request object for setting or clearing the location a door station is assigned to.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "tokenUuid" ] }, "Doorstation_UpdateDoorStationLocationWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Doorstation_UpdateDoorStationVideoWallsWSRequest" : { "type" : "object", "description" : "Request object for replacing the video walls assigned to a door station.", "properties" : { "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuids" : { "type" : "array", "description" : "The full set of video walls to assign. Replaces the current set; an empty list clears it. Each wall must be unowned, or shared with at least one device.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } }, "required" : [ "tokenUuid", "videoWallUuids" ] }, "Doorstation_UpdateDoorStationVideoWallsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "videoWallUuids" : { "type" : "array", "description" : "Video walls now assigned to this door station", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "DropboxSettingsV2" : { "type" : "object", "description" : "Dropbox integration settings to update", "properties" : { "accessToken" : { "type" : "string", "nullable" : true }, "accountEmail" : { "type" : "string", "nullable" : true }, "accountName" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "DtcInfo" : { "type" : "object", "nullable" : true, "properties" : { "code" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "failing" : { "type" : "boolean", "nullable" : true }, "hasFailed" : { "type" : "boolean", "nullable" : true }, "testCompleted" : { "type" : "boolean", "nullable" : true }, "time" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "DwellEventType" : { "type" : "object", "nullable" : true, "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "deviceLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "dwellStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationLabels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "regionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "thumbnailLocation" : { "type" : "string", "nullable" : true }, "thumbnailUri" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "trackId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DwellStrategyEnum" : { "type" : "string", "default" : "DURATION", "description" : "Strategy for how long the robot dwells at this waypoint", "enum" : [ "NONE", "DURATION", "TIME_ABSOLUTE", "EVENT", "MANUAL", "UNKNOWN" ] }, "DynamoPageRequest" : { "type" : "object", "description" : "Pagination request for retrieving policy alerts. Page size must be between 1 and 1000.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "DynamoPageResultALMEvent" : { "type" : "object", "description" : "Paginated list of ALM events matching the request.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "page" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ALMEvent" }, "nullable" : true } } }, "E50ClimateEventType" : { "type" : "object", "description" : "List of climate events for the environmental gateway", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "alertTriggerThresholds" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "alertTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "carbonMonoSense" : { "$ref" : "#/components/schemas/COSensorType" }, "clipMetaData" : { "$ref" : "#/components/schemas/ClipMetaDataType" }, "co2Sense" : { "$ref" : "#/components/schemas/Co2SensorType" }, "derivedValues" : { "$ref" : "#/components/schemas/E50DerivedValuesType" }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "formaSense" : { "$ref" : "#/components/schemas/FormaSensorType" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "leakProbe" : { "$ref" : "#/components/schemas/LeakProbeType" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pmSense" : { "$ref" : "#/components/schemas/PmSensorType" }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pressSense" : { "$ref" : "#/components/schemas/PressureSensorType" }, "tempProbe" : { "$ref" : "#/components/schemas/TempProbeType" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "E50DerivedValuesType" : { "type" : "object", "properties" : { "airQualityIndex" : { "type" : "integer", "format" : "int32", "nullable" : true }, "airQualityIndexPollutant" : { "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" }, "calibrating" : { "type" : "boolean", "nullable" : true }, "deviceOrientation" : { "$ref" : "#/components/schemas/DeviceOrientationEnum" }, "falsePositiveConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true }, "heatIndexDegF" : { "type" : "number", "format" : "double", "nullable" : true }, "heatIndexRangeWarning" : { "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" }, "indoorAirQuality" : { "type" : "number", "format" : "float", "nullable" : true }, "malfunctioningModules" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "smokeConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true }, "smokeThcConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true }, "smokeTobaccoConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true }, "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "tvoc" : { "type" : "number", "format" : "float", "nullable" : true }, "vapeConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true }, "vapeDetected" : { "type" : "boolean", "nullable" : true }, "vapeThcConfidencePercent" : { "type" : "number", "format" : "float", "nullable" : true } } }, "EarlyExpireModeEnum" : { "type" : "string", "enum" : [ "SCHEDULED_CHANGE", "STEADY_STATE_CHANGE", "OFF" ] }, "EditPeriodAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "absoluteIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "autoDailyInterval" : { "type" : "boolean", "nullable" : true }, "dailyIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DailyMinuteIntervalType" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "action" : { "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" } }, "required" : [ "action" ] }, "ElevatorLandingReference" : { "type" : "object", "properties" : { "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "relayComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType" }, "nullable" : true, "uniqueItems" : true } } }, "ElevatorLandingReference_Minimal" : { "type" : "object", "properties" : { "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "relayComponents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true } } }, "EmailAuditLogExportActionType" : { "type" : "object", "properties" : { "includeActions" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "includeApiInvocation" : { "type" : "boolean", "nullable" : true }, "lookbackCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lookbackType" : { "$ref" : "#/components/schemas/ReportLookbackTypeEnum" }, "lookbackUnit" : { "$ref" : "#/components/schemas/ReportLookbackUnitEnum" }, "recipientEmails" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "timezoneId" : { "type" : "string", "nullable" : true } } }, "EmailSettings" : { "type" : "object", "properties" : { "emailAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Embedding" : { "type" : "object", "description" : "Returns the generated embedding or null if the embedding could not be generated. If image contains multiple faces, only the first generated embedding is returned.", "properties" : { "embeddingComparisonType" : { "type" : "string", "nullable" : true }, "embeddingConfidence" : { "type" : "number", "format" : "float", "nullable" : true }, "embeddingEncodingType" : { "$ref" : "#/components/schemas/EmbeddingEncodingTypeEnum" }, "encodedEmbedding" : { "type" : "string", "nullable" : true } } }, "EmbeddingEncodingTypeEnum" : { "type" : "string", "enum" : [ "Q_8_24", "IEEE_754" ] }, "EmergencyContact" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the emergency contact.", "nullable" : true }, "phoneNumber" : { "type" : "string", "description" : "The phone number for this emergency contact.", "nullable" : true } }, "required" : [ "name", "phoneNumber" ] }, "EmergencyContactPolicy" : { "type" : "object", "description" : "Emergency contacts that may be notified after threat detection occurs at this zone.\n", "nullable" : true, "properties" : { "emergencyContacts" : { "type" : "array", "description" : "The emergency contacts eligible to be notified under this configuration.", "items" : { "$ref" : "#/components/schemas/EmergencyContact" }, "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "emergencyContacts", "scheduleUuid" ] }, "EmergencyResponseContactsIntervalType" : { "type" : "object", "properties" : { "emergencyContactList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmergencyContact" }, "nullable" : true }, "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfWeekStop" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "EmergencyResponseContactsScheduleType" : { "type" : "object", "properties" : { "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "emergencyContactList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmergencyContact" }, "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "EnableDisableAudioRecordActionRecordType" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "enable" : { "type" : "boolean", "nullable" : true }, "succeeded" : { "type" : "boolean", "nullable" : true } } }, "EnableDisableAudioRecordActionType" : { "type" : "object", "properties" : { "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "enable" : { "type" : "boolean", "nullable" : true } } }, "EntityEnum" : { "type" : "string", "description" : "Entity object for exposing to OpenAPI component schemas", "enum" : [ "ALARM_MONITORING_LOCATION_SETTINGS", "ALARM_MONITORING_LICENSE", "DEVICE", "LOCATION", "POLICY", "POLICY_ALERT", "POLICY_ADDENDUM", "POLICY_PAUSE", "USER", "CAMERA_USER_CONFIG", "ORG", "USER_PERMISSION_GROUP", "PARTNER_PERMISSION_GROUP", "VIDEO_WALL", "SHARED_CLIPS", "SAVED_CLIPS", "SHARED_STREAMS", "SPLICED_CLIPS", "TIMELAPSE", "AUDIT_EVENTS", "DIAGNOSTIC_EVENTS", "CAMERA_STATE", "CLIMATE_STATE", "DOOR_STATE", "NVR_STATE", "OCCUPANCY_STATE", "PROXIMITY_STATE", "AUDIO_STATE", "CAMERA", "NVR", "DOOR_SENSOR", "CLIMATE_SENSOR", "PROXIMITY_SENSOR", "BOUNDING_BOX", "SEEK_POINT", "SENSOR_SEEK_POINT", "SCHEDULE", "FACE_EVENT", "DEVICE_SHADOW", "THREAT_CASE", "THREAT_CASE_REVIEWER", "KEYPAD", "COMPONENT_DOOR_READER_SHADOW", "COMPONENT_DOOR_RELAY_SHADOW", "COMPONENT_DOOR_POSITION_INDICATOR_SHADOW", "COMPONENT_APERIO_GATEWAY_SHADOW", "COMPONENT_APERIO_DOOR_EXT_SHADOW", "COMPONENT_SCHLAGE_GATEWAY_SHADOW", "COMPONENT_SCHLAGE_DOOR_EXT_SHADOW", "COMPONENT_REQUEST_TO_EXIT_SHADOW", "COMPONENT_GENERIC_RELAY_SHADOW", "COMPONENT_GENERIC_INPUT_SHADOW", "COMPONENT_GENERIC_BUTTON_SHADOW", "ACCESS_CONTROLLED_DOOR_SHADOW", "ACCESS_CONTROLLED_DOOR", "ACCESS_CONTROLLED_ELEVATOR_SHADOW", "ACCESS_CONTROLLED_ELEVATOR", "ACCESS_CONTROLLED_ELEVATOR_LANDING_SHADOW", "ACCESS_CONTROLLED_ELEVATOR_LANDING", "COMPONENT_SEEKPOINT", "ROBOT_SEEKPOINT", "VEHICLE_EVENT", "DEVICE_INTEGRATION", "SHELLY_INTEGRATION", "THIRD_PARTY_CAMERA_DISCOVERY", "THIRD_PARTY_CAMERA_ASSIGNMENT", "THIRD_PARTY_CAMERA_CREDENTIAL", "CHATBOT_QUERY", "KEYPAD_COMMAND", "PRIORITY_DETECTION", "LIVE_DETECTION", "LIVE_OCCUPANCY", "UNKNOWN" ] }, "EntityTag" : { "type" : "object", "nullable" : true, "properties" : { "value" : { "type" : "string", "nullable" : true }, "weak" : { "type" : "boolean", "nullable" : true } } }, "EnvironmentalGatewaySettings" : { "type" : "object", "properties" : { "data_measurement_interval_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "data_upload_interval_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "false_positive_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "leak_detection_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "leak_detector_present" : { "type" : "boolean", "nullable" : true }, "moist_detection_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_thc_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_tobacco_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vape_alert_backoff_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "vape_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vape_thc_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "EnvironmentalGatewaySettingsSelectiveUpdate" : { "type" : "object", "description" : "Update Environmental Sensor settings", "properties" : { "data_measurement_interval_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "data_upload_interval_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "false_positive_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "leak_detection_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "leak_detector_present" : { "type" : "boolean", "nullable" : true }, "moist_detection_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_thc_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "smoke_tobacco_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "vape_alert_backoff_sec" : { "type" : "integer", "format" : "int64", "nullable" : true }, "vape_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vape_thc_confidence_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "EnvironmentalGatewayShadowType" : { "type" : "object", "description" : "List of environmental gateway shadows", "properties" : { "activeAlertTriggers" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "apMac" : { "type" : "string", "nullable" : true }, "carbonMonoSense" : { "$ref" : "#/components/schemas/COSensorType" }, "co2Sense" : { "$ref" : "#/components/schemas/Co2SensorType" }, "connected" : { "type" : "boolean", "nullable" : true }, "connectionTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "connectionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "derivedValues" : { "$ref" : "#/components/schemas/E50DerivedValuesType" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "disconnectTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "formaSense" : { "$ref" : "#/components/schemas/FormaSensorType" }, "hardwareUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "internalWanAddress" : { "type" : "string", "nullable" : true }, "jumpHostUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "leakProbe" : { "$ref" : "#/components/schemas/LeakProbeType" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pmSense" : { "$ref" : "#/components/schemas/PmSensorType" }, "pressSense" : { "$ref" : "#/components/schemas/PressureSensorType" }, "prevConnected" : { "type" : "boolean", "nullable" : true }, "prevConnectedUpdateTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "state" : { "type" : "object", "additionalProperties" : { "type" : "object", "nullable" : true }, "nullable" : true }, "stateUpdatedTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "tempProbe" : { "$ref" : "#/components/schemas/TempProbeType" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "wanAddress" : { "type" : "string", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "EnvoyCustomField" : { "type" : "object", "properties" : { "field" : { "type" : "string", "nullable" : true }, "value" : { "type" : "string", "nullable" : true } } }, "EnvoyDelivery" : { "type" : "object", "properties" : { "carrier" : { "$ref" : "#/components/schemas/EnvoyDeliveryInfo" }, "carrierInfo" : { "$ref" : "#/components/schemas/EnvoyDeliveryInfo" }, "deliveryArea" : { "$ref" : "#/components/schemas/EnvoyDeliveryInfo" }, "deliveryAreaInfo" : { "$ref" : "#/components/schemas/EnvoyDeliveryInfo" }, "locationId" : { "type" : "string", "nullable" : true }, "pickedUpAt" : { "type" : "string", "nullable" : true }, "pickedUpBy" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "receivedTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "recipient" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "status" : { "type" : "string", "nullable" : true } } }, "EnvoyDeliveryInfo" : { "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true } } }, "EnvoyExpectedGuest" : { "type" : "object", "properties" : { "expectedArrivalAt" : { "type" : "string", "nullable" : true }, "expectedArrivalTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "host" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "invitee" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "locationId" : { "type" : "string", "nullable" : true } } }, "EnvoyGuest" : { "type" : "object", "properties" : { "agreementsStatus" : { "type" : "string", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "fullName" : { "type" : "string", "nullable" : true }, "host" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "locationId" : { "type" : "string", "nullable" : true }, "notes" : { "type" : "string", "nullable" : true }, "signedInAt" : { "type" : "string", "nullable" : true }, "signedInTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "signedOutAt" : { "type" : "string", "nullable" : true }, "signedOutTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "EnvoyInvite" : { "type" : "object", "properties" : { "customFields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyCustomField" }, "nullable" : true }, "expectedArrivalAt" : { "type" : "string", "nullable" : true }, "expectedDepartureAt" : { "type" : "string", "nullable" : true }, "flowId" : { "type" : "string", "nullable" : true }, "hostEmployeeId" : { "type" : "string", "nullable" : true }, "inviteId" : { "type" : "string", "nullable" : true }, "invitee" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "locationId" : { "type" : "string", "nullable" : true }, "notes" : { "type" : "string", "nullable" : true }, "sendEmailToInvitee" : { "type" : "boolean", "nullable" : true } } }, "EnvoyLocation" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "EnvoyLocationInfoType" : { "type" : "object", "nullable" : true, "properties" : { "assignedCameraList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "locationName" : { "type" : "string", "nullable" : true } } }, "EnvoyPersonInfo" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "locationIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "locations" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "nullable" : true } } }, "EnvoySettings" : { "type" : "object", "description" : "Envoy visitor management integration settings to update", "properties" : { "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "envoyIntegrationInstalled" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "locationInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EnvoyLocationInfoType" }, "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "EnvoyType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "envoyIntegrationInstalled" : { "type" : "boolean", "nullable" : true }, "envoyUserSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EnvoyUserSettings" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "locationInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EnvoyLocationInfoType" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "EnvoyUserSettings" : { "type" : "object", "nullable" : true, "properties" : { "guestsEnabled" : { "type" : "boolean", "nullable" : true }, "packagesEnabled" : { "type" : "boolean", "nullable" : true } } }, "EpochSecondsProvisioner" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/StaticEpochSecondsProvisioner" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "ErrorCodeOrMessageEnum" : { "type" : "string", "enum" : [ "BADGE_READER_UNKNOWN", "DEAD_OR_MISSING_BATTERY", "DOORBELL_BUTTON_ISSUE", "ERROR_2", "ERROR_4", "ERROR_5", "ERROR_24", "ERROR_28", "ERROR_30", "ERROR_39", "ERROR_74", "ERROR_84", "FOREIGN_HARDWARE", "BAD_SD_BLOCKS", "NEVER_LEFT_BUSY_STATE", "HARDWARE_DAMAGE", "HEAVY_HARDWARE_DAMAGE", "WATER_DAMAGE", "VIDEO_HARDWARE_FAILURE", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "LIGHT_SENSOR", "SD_CARD_UNKOWN", "SD_CARD_READER_BROKEN", "POWER_ISSUES", "RS485_ISSUE", "CUT_FILTER", "QUALITY_OR_PERFORMANCE", "NETWORK_ISSUES", "UNKNOWN", "ILLEGIBLE_SERIAL_COMM", "NO_SERIAL_COMM", "COSMETIC_DAMAGE", "IR_RING_OVERHEATED", "REGISTERED_SENSOR", "UNDISCOVERED_ISSUE", "FOCUS_ISSUES", "FIRMWARE_REFLASH_REQUIRED", "POTENTIAL_MANUFACTURING_DEFECT", "NO_FAULT_FOUND", "FDT_COMMAND_LINE_ERROR", "KERNEL_PANIC", "GET_DTB_FAILED", "POTENTIAL_FIRMWARE_ISSUE", "BOOTS_TO_AMBOOT" ] }, "Ethernettester_GetEthernetTesterConfigWSRequest" : { "type" : "object", "description" : "Request object for retrieving Ethernet tester configuration.", "properties" : { "version" : { "type" : "string", "description" : "Version of the Ethernet tester configuration", "example" : "1.0", "nullable" : true } } }, "Ethernettester_GetEthernetTesterConfigWSResponse" : { "type" : "object", "description" : "Response object containing Ethernet tester configuration.", "properties" : { "configJson" : { "type" : "string", "description" : "JSON configuration for the Ethernet tester", "example" : "{\"testMode\":\"ping\",\"targetHost\":\"192.168.1.1\"}", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "EventCount" : { "type" : "object", "properties" : { "count" : { "type" : "number", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "EventListenerType" : { "type" : "object", "description" : "List of event listeners for the specified device", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "clientCertificate" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "clientKey" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hostname" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "trustedCertificate" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "uri" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "EventOriginatorEnum" : { "type" : "string", "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "GUEST_PASS", "DEVICE_SERVICE", "UNKNOWN" ] }, "EventOriginatorEnum_Minimal" : { "type" : "string", "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "GUEST_PASS", "DEVICE_SERVICE", "UNKNOWN" ] }, "EventTimelineEntry" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "customActivityDescription" : { "type" : "string", "description" : "Custom description for the activity.", "example" : "A person was detected in the camera view", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "description" : "Custom display name for the activity.", "example" : "Person Detected", "nullable" : true }, "device" : { "$ref" : "#/components/schemas/TimelineEntryDevice" }, "subjectEntityName" : { "type" : "string", "description" : "Name or identifier associated with the event, such as a person's name or a vehicle license plate. Null when the entry is redacted.", "nullable" : true } } } ], "description" : "A timeline entry recording an event a device observed, such as a face or a vehicle.", "nullable" : true, "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "imageKey" : { "type" : "string", "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, "location" : { "$ref" : "#/components/schemas/TimelineEntryLocation" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "systemGenerated" : { "type" : "boolean", "description" : "Whether the entry was generated by the system rather than created by a user.", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/TimelineEntryTypeEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "EventTimestampFilter" : { "type" : "object", "description" : "A time range, in milliseconds since the epoch. Which bounds are required depends on the request that carries this filter.", "properties" : { "endTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Inclusive upper bound of the time range.", "nullable" : true }, "startTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Inclusive lower bound of the time range.", "nullable" : true } } }, "Event_CalculateAlertMonitoringThreatCaseStatsByOrgWSRequest" : { "type" : "object", "description" : "Request object for calculating alert monitoring threat case stats by organization.", "properties" : { "reportInterval" : { "$ref" : "#/components/schemas/ThreatCaseReportIntervalEnum" }, "threatCaseCreatedAtFilter" : { "$ref" : "#/components/schemas/EventTimestampFilter" }, "timeZone" : { "type" : "object", "description" : "Time zone the interval buckets are aligned to, defaults to UTC", "nullable" : true, "properties" : { "displayName" : { "type" : "string", "nullable" : true }, "dstsavings" : { "type" : "integer", "format" : "int32", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "rawOffset" : { "type" : "integer", "format" : "int32", "nullable" : true } } } } }, "Event_CalculateAlertMonitoringThreatCaseStatsByOrgWSResponse" : { "type" : "object", "description" : "Response object containing aggregate alert monitoring threat case stats for an organization.", "properties" : { "alertCount" : { "type" : "integer", "format" : "int32", "description" : "Number of alerts across the matching threat cases", "nullable" : true }, "averageAlarmCloseSeconds" : { "type" : "integer", "format" : "int32", "description" : "Average time in seconds from threat case creation to alarm close", "nullable" : true }, "averageResponseSeconds" : { "type" : "integer", "format" : "int32", "description" : "Average time in seconds from threat case creation to dismissal or escalation by a reviewer. Cases resolved without one, such as a panic button escalating on its own, are excluded.", "nullable" : true }, "closedCount" : { "type" : "integer", "format" : "int32", "description" : "Number of closed threat cases", "nullable" : true }, "dismissedCount" : { "type" : "integer", "format" : "int32", "description" : "Number of dismissed threat cases", "nullable" : true }, "escalatedCount" : { "type" : "integer", "format" : "int32", "description" : "Number of escalated threat cases", "nullable" : true }, "externalReviewerStats" : { "$ref" : "#/components/schemas/ThreatCaseReviewerStats" }, "internalReviewerStats" : { "type" : "array", "description" : "Stats for each internal reviewer.", "items" : { "$ref" : "#/components/schemas/ThreatCaseReviewerStats" }, "nullable" : true }, "openCount" : { "type" : "integer", "format" : "int32", "description" : "Number of open threat cases", "nullable" : true }, "statsByIntervalStartMs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ThreatCaseIntervalStats" }, "description" : "Stats keyed by the start of each interval", "nullable" : true }, "timedOutCount" : { "type" : "integer", "format" : "int32", "description" : "Number of timed out threat cases", "nullable" : true }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "Total number of threat cases matching the filter", "nullable" : true } } }, "Event_CreateSharedClipGroupWSRequest" : { "type" : "object", "description" : "Request object for creating a shared clip group.", "properties" : { "expirationTimeSecs" : { "type" : "integer", "format" : "int32", "description" : "Expiration time in seconds for the shared clip group", "example" : 86400, "nullable" : true }, "plaintextPassword" : { "type" : "string", "description" : "Optional password for accessing the shared clip group", "example" : "mypassword123", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the shared clip group", "example" : "Security Incident - Main Entrance", "nullable" : true }, "uuids" : { "type" : "array", "description" : "List of UUIDs for clips to include in the shared group", "items" : { "$ref" : "#/components/schemas/Event_RuuidWrapper" }, "nullable" : true } } }, "Event_CreateSharedClipGroupWSResponse" : { "type" : "object", "description" : "Response object for creating a shared clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "shareUrl" : { "type" : "string", "description" : "URL for accessing the shared clip group", "example" : "https://share.rhombus.com/clips/abc123", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DeleteAlertMonitoringThreatCaseByStatusWSRequest" : { "type" : "object", "description" : "Request object for deleting alert monitoring threat cases by status.", "properties" : { "status" : { "$ref" : "#/components/schemas/ThreatCaseStatusEnum" } } }, "Event_DeleteAlertMonitoringThreatCaseByStatusWSResponse" : { "type" : "object", "description" : "Response object for deleting alert monitoring threat cases by status.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DeleteAlertMonitoringThreatCaseWSRequest" : { "type" : "object", "description" : "Request object for deleting alert monitoring threat cases.", "properties" : { "threatCaseUuids" : { "type" : "array", "description" : "List of threat case UUIDs to delete", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Event_DeleteAlertMonitoringThreatCaseWSResponse" : { "type" : "object", "description" : "Response object for deleting alert monitoring threat cases.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DeleteSavedClipWSRequest" : { "type" : "object", "description" : "Request object for deleting a saved clip.", "properties" : { "savedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_DeleteSavedClipWSResponse" : { "type" : "object", "description" : "Response object for deleting a saved clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DeleteSharedClipGroupWSRequest" : { "type" : "object", "description" : "Request object for deleting a shared clip group.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_DeleteSharedClipGroupWSResponse" : { "type" : "object", "description" : "Response object for deleting a shared clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DismissAllPolicyAlertsForDeviceWSRequest" : { "type" : "object", "description" : "Request object for dismissing all policy alerts for specific devices.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to dismiss alerts for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Event_DismissAllPolicyAlertsForDeviceWSResponse" : { "type" : "object", "description" : "Response object for dismissing all policy alerts for specific devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DismissAllPolicyAlertsWSRequest" : { "type" : "object", "description" : "Request object for dismissing all policy alerts." }, "Event_DismissAllPolicyAlertsWSResponse" : { "type" : "object", "description" : "Response object for dismissing all policy alerts.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DismissPolicyAlertWSRequest" : { "type" : "object", "description" : "Request object for dismissing a policy alert.", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_DismissPolicyAlertWSResponse" : { "type" : "object", "description" : "Response object for dismissing a policy alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_DismissPolicyAlertsWSRequest" : { "type" : "object", "description" : "Request object for dismissing multiple policy alerts.", "properties" : { "alertUuids" : { "type" : "array", "description" : "List of policy alert UUIDs to dismiss", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Event_DismissPolicyAlertsWSResponse" : { "type" : "object", "description" : "Response object for dismissing multiple policy alerts.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_FrontendCell" : { "type" : "object", "description" : "Represents a cell in the motion grid with column and row coordinates.", "properties" : { "col" : { "type" : "integer", "format" : "int32", "description" : "Column coordinate of the cell", "example" : 5, "nullable" : true }, "row" : { "type" : "integer", "format" : "int32", "description" : "Row coordinate of the cell", "example" : 3, "nullable" : true } } }, "Event_GetAlertMonitoringThreatCaseWSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific alert monitoring threat case.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetAlertMonitoringThreatCaseWSResponse" : { "type" : "object", "description" : "Response object containing a specific alert monitoring threat case.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "threatCase" : { "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetAlertMonitoringThreatCasesWSRequest" : { "type" : "object", "description" : "Request object for retrieving alert monitoring threat cases with filtering and pagination options.", "properties" : { "afterTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for threat cases after this timestamp", "example" : 1640995200000, "nullable" : true }, "beforeTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for threat cases before this timestamp", "example" : 1641081600000, "nullable" : true }, "deviceFilter" : { "type" : "array", "description" : "List of device UUIDs to filter by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Last timestamp for pagination", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationFilter" : { "type" : "array", "description" : "List of location UUIDs to filter by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return", "example" : 100, "nullable" : true }, "mostRecent" : { "type" : "boolean", "description" : "Whether to return only the most recent threat cases", "example" : true, "nullable" : true }, "statusFilter" : { "type" : "array", "description" : "List of threat case statuses to filter by", "items" : { "$ref" : "#/components/schemas/ThreatCaseStatusEnum" }, "nullable" : true } } }, "Event_GetAlertMonitoringThreatCasesWSResponse" : { "type" : "object", "description" : "Response object containing alert monitoring threat cases with pagination information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "threatCases" : { "type" : "array", "description" : "List of threat cases matching the request criteria", "items" : { "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetClipWithProgressWSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific clip with progress information.", "properties" : { "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "clipUuid" ] }, "Event_GetClipWithProgressWSResponse" : { "type" : "object", "description" : "Response object containing a specific clip with progress information.", "properties" : { "clip" : { "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetClipsWithProgressWSRequest" : { "type" : "object", "description" : "Request object for retrieving clips with progress information and filtering options.", "properties" : { "deviceUuidFilters" : { "type" : "array", "description" : "Device uuids to filter clips by.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "excludeAlertMonitoringClips" : { "type" : "boolean", "default" : false, "description" : "Filter to exclude clips created for alarm monitoring verification.", "nullable" : true }, "filterByPrivate" : { "type" : "boolean", "default" : false, "description" : "Filter to only include private clips in the result.", "nullable" : true }, "locationUuidFilters" : { "type" : "array", "description" : "Location uuids to filter clips by.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "pageSize" : { "type" : "integer", "format" : "int32", "default" : 100, "description" : "Page size", "maximum" : 200, "minimum" : 1, "nullable" : true }, "pageToken" : { "type" : "string", "description" : "Page token received from the previous search request.", "example" : "next_page_token_123", "nullable" : true }, "searchFilter" : { "type" : "string", "description" : "Search filter for clips", "example" : "motion detected", "nullable" : true }, "sortField" : { "type" : "string", "description" : "Field to sort clips by", "example" : "timestamp", "nullable" : true }, "sortOrder" : { "type" : "string", "description" : "Sort order (asc or desc)", "example" : "desc", "nullable" : true }, "timestampFilterField" : { "type" : "string", "description" : "Timestamp to filter clips by (either clip creation date or clip footage date).", "nullable" : true }, "timestampMsAfter" : { "type" : "integer", "format" : "int64", "description" : "Timestamp to find clips after this time.", "example" : 1640995200000, "nullable" : true }, "timestampMsBefore" : { "type" : "integer", "format" : "int64", "description" : "Timestamp to find clips before this time", "example" : 1641081600000, "nullable" : true } }, "required" : [ "pageSize" ] }, "Event_GetClipsWithProgressWSResponse" : { "type" : "object", "description" : "Response object containing clips with progress information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pageToken" : { "type" : "string", "description" : "Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.", "nullable" : true }, "savedClips" : { "type" : "array", "description" : "List of saved clips with progress information", "items" : { "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetExpiringPolicyAlertsWSRequest" : { "type" : "object", "description" : "Request object for retrieving expiring policy alerts.", "properties" : { "expiresBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp in milliseconds. Used to find policy alerts that expire before this timestamp.\n", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } }, "required" : [ "expiresBeforeMs" ] }, "Event_GetExpiringPolicyAlertsWSResponse" : { "type" : "object", "description" : "Response object containing a list of expiring policy alerts.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Key used to resume pagination, if applicable", "nullable" : true }, "policyAlerts" : { "type" : "array", "description" : "List of expiring policy alerts", "items" : { "$ref" : "#/components/schemas/BasePolicyAlertType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetMotionGridCountsWSResponse" : { "type" : "object", "description" : "Response object containing motion grid counts for a device.", "properties" : { "countGrid" : { "type" : "array", "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "items" : { "type" : "array", "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "items" : { "type" : "integer", "format" : "int32", "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "nullable" : true }, "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetMotionGridWSRequest" : { "type" : "object", "description" : "Request object for retrieving motion grid data for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "endTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "End time as a UNIX timestamp in seconds", "example" : 1641081600, "nullable" : true }, "startTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "Start time as a UNIX timestamp in seconds", "example" : 1640995200, "nullable" : true } }, "required" : [ "deviceUuid", "endTimeUtcSecs", "startTimeUtcSecs" ] }, "Event_GetMotionGridWSResponse" : { "type" : "object", "description" : "Response object containing motion grid data for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "motionCells" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of timestamps to motion grid cells", "items" : { "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, "description" : "Map of timestamps to motion grid cells", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertCountWSRequest" : { "type" : "object", "description" : "Request object for retrieving the count of policy alerts.", "properties" : { "maxResultsSize" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to count", "example" : 1000, "nullable" : true } } }, "Event_GetPolicyAlertCountWSResponse" : { "type" : "object", "description" : "Response object containing the count of policy alerts.", "properties" : { "count" : { "type" : "integer", "format" : "int32", "description" : "Count of policy alerts", "example" : 42, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertDetailsWSRequest" : { "type" : "object", "description" : "Request object for retrieving detailed information about a policy alert.", "properties" : { "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetPolicyAlertDetailsWSResponse" : { "type" : "object", "description" : "Response object containing detailed information about a policy alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlert" : { "$ref" : "#/components/schemas/PolicyAlertWithDetailsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertGroupsForDeviceWSRequest" : { "type" : "object", "description" : "Request object for retrieving policy alert groups for a specific device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Last timestamp for pagination (required with LastUuid)", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return", "example" : 100, "nullable" : true } } }, "Event_GetPolicyAlertGroupsForDeviceWSResponse" : { "type" : "object", "description" : "Response object containing policy alert groups for a specific device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlertGroups" : { "type" : "array", "description" : "List of policy alert groups for the device", "items" : { "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertGroupsForLocationWSRequest" : { "type" : "object", "description" : "Request object for retrieving policy alert groups for a specific location.", "properties" : { "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Last timestamp for pagination", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return", "example" : 100, "nullable" : true } } }, "Event_GetPolicyAlertGroupsForLocationWSResponse" : { "type" : "object", "description" : "Response object containing policy alert groups for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlertGroups" : { "type" : "array", "description" : "List of policy alert groups for the location", "items" : { "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertGroupsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving policy alert groups V2 with pagination options.", "properties" : { "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Last timestamp for pagination", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return", "example" : 100, "nullable" : true } } }, "Event_GetPolicyAlertGroupsV2WSResponse" : { "type" : "object", "description" : "Response object containing policy alert groups V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlertGroups" : { "type" : "array", "description" : "List of policy alert groups V2", "items" : { "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific policy alert V2.", "properties" : { "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetPolicyAlertV2WSResponse" : { "type" : "object", "description" : "Response object containing a specific policy alert V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlert" : { "$ref" : "#/components/schemas/PolicyAlertV2Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertWSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific policy alert.", "properties" : { "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetPolicyAlertWSResponse" : { "type" : "object", "description" : "Response object containing a specific policy alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlert" : { "$ref" : "#/components/schemas/BasePolicyAlertType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving policy alerts V2 with filtering and pagination options.", "properties" : { "afterTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for alerts after this timestamp", "example" : 1640995200000, "nullable" : true }, "beforeTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for alerts before this timestamp", "example" : 1641081600000, "nullable" : true }, "deviceFilter" : { "type" : "array", "description" : "List of device UUIDs to filter by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Last timestamp for pagination", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationFilter" : { "type" : "array", "description" : "List of location UUIDs to filter by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of results to return", "example" : 100, "nullable" : true } } }, "Event_GetPolicyAlertsV2WSResponse" : { "type" : "object", "description" : "Response object containing policy alerts V2 with filtering and pagination options.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "oldestPolicyAlert" : { "$ref" : "#/components/schemas/PolicyAlertV2Type" }, "policyAlerts" : { "type" : "array", "description" : "List of policy alerts V2 matching the request criteria", "items" : { "$ref" : "#/components/schemas/PolicyAlertV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetPolicyAlertsWSRequest" : { "type" : "object", "description" : "Request object for retrieving policy alerts with filtering and pagination options.", "properties" : { "accessControlledDoorFilter" : { "type" : "array", "description" : "Filter including chosen Access Controlled Doors", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "afterTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Enter starting timestamp interval in UNIX ms", "example" : 1640995200000, "nullable" : true }, "beforeTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Enter ending timestamp interval in UNIX ms", "example" : 1641081600000, "nullable" : true }, "deviceFilter" : { "type" : "array", "description" : "Filter including chosen Devices", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "lastTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Search with last known TimestampMs (Required for Pagination)", "example" : 1640995200000, "nullable" : true }, "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationFilter" : { "type" : "array", "description" : "Filter any locations you would like to include", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Set a max result limit", "example" : 100, "nullable" : true } } }, "Event_GetPolicyAlertsWSResponse" : { "type" : "object", "description" : "Response object containing a list of policy alerts.", "nullable" : true, "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "policyAlerts" : { "type" : "array", "description" : "List of policy alerts matching the request criteria", "items" : { "$ref" : "#/components/schemas/BasePolicyAlertType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSavedClipCountWSRequest" : { "type" : "object", "description" : "Request object for retrieving the count of saved clips with filtering options.", "properties" : { "deviceFilter" : { "type" : "array", "description" : "List of device UUIDs to filter clips by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering clips", "example" : 1641081600000, "nullable" : true }, "locationFilter" : { "type" : "array", "description" : "List of location UUIDs to filter clips by", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering clips", "example" : 1640995200000, "nullable" : true } } }, "Event_GetSavedClipCountWSResponse" : { "type" : "object", "description" : "Response object containing the count of saved clips.", "properties" : { "count" : { "type" : "integer", "format" : "int64", "description" : "Count of org-wide saved clips matching the filter criteria", "example" : 42, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "privateCount" : { "type" : "integer", "format" : "int64", "description" : "Count of private saved clips matching the filter criteria", "example" : 10, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSavedClipDetailsWSRequest" : { "type" : "object", "description" : "Request object for retrieving detailed information about a saved clip.", "properties" : { "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetSavedClipDetailsWSResponse" : { "type" : "object", "description" : "Response object containing detailed information about a saved clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "savedClip" : { "$ref" : "#/components/schemas/SavedClipWithDetailsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSavedClipsByExternalTransactionIdWSRequest" : { "type" : "object", "description" : "Request object for retrieving saved clips by external transaction ID.", "properties" : { "externalTransactionId" : { "type" : "string", "description" : "External transaction ID to search for saved clips", "example" : "txn_123456789", "nullable" : true } } }, "Event_GetSavedClipsByExternalTransactionIdWSResponse" : { "type" : "object", "description" : "Response object containing saved clips by external transaction ID.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "savedClips" : { "type" : "array", "description" : "List of saved clips matching the external transaction ID", "items" : { "$ref" : "#/components/schemas/SavedClipV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSavedClipsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving saved clips with pagination.", "properties" : { "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Set max results returned. Note: in future this will be defaulted to 100", "example" : 100, "nullable" : true }, "pageTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp start to specify page of up to 100 saved clips", "example" : 1640995200000, "nullable" : true } } }, "Event_GetSavedClipsV2WSResponse" : { "type" : "object", "description" : "Response object containing saved clips with pagination.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the last evaluated clip for pagination", "nullable" : true }, "savedClips" : { "type" : "array", "description" : "List of saved clips", "items" : { "$ref" : "#/components/schemas/SavedClipV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSavedClipsWSRequest" : { "type" : "object", "description" : "Request object for retrieving saved clips (deprecated)." }, "Event_GetSavedClipsWSResponse" : { "type" : "object", "description" : "Response object containing saved clips (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "savedClips" : { "type" : "array", "description" : "List of saved clips", "items" : { "$ref" : "#/components/schemas/SavedClipV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSharedClipGroupDetailsWSRequest" : { "type" : "object", "description" : "Request object for retrieving detailed information about a shared clip group.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_GetSharedClipGroupDetailsWSResponse" : { "type" : "object", "description" : "Response object containing detailed information about a shared clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedClipGroup" : { "$ref" : "#/components/schemas/SharedClipGroupWithDetailsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSharedClipGroupsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving shared clip groups with date filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for clip groups created after this timestamp", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for clip groups created before this timestamp", "example" : 1641081600000, "nullable" : true } } }, "Event_GetSharedClipGroupsV2WSResponse" : { "type" : "object", "description" : "Response object containing shared clip groups with date filtering.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedClipGroups" : { "type" : "array", "description" : "List of shared clip groups", "items" : { "$ref" : "#/components/schemas/SharedClipGroupWrapperV2Type" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSharedClipGroupsWSRequest" : { "type" : "object", "description" : "Request object for retrieving shared clip groups (deprecated)." }, "Event_GetSharedClipGroupsWSResponse" : { "type" : "object", "description" : "Response object containing shared clip groups (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sharedClipGroups" : { "type" : "array", "description" : "List of shared clip groups", "items" : { "$ref" : "#/components/schemas/SharedClipGroupWrapperType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetSplicedClipsInProgressWSRequest" : { "type" : "object", "description" : "Request object for retrieving spliced clips in progress (deprecated)." }, "Event_GetSplicedClipsInProgressWSResponse" : { "type" : "object", "description" : "Response object containing spliced clips in progress (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "splicedClips" : { "type" : "array", "description" : "List of spliced clips currently in progress", "items" : { "$ref" : "#/components/schemas/SplicedClipType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_GetUnhealthyDeviceAlertsWSRequest" : { "type" : "object", "description" : "Request object for retrieving unhealthy device alerts." }, "Event_GetUnhealthyDeviceAlertsWSResponse" : { "type" : "object", "description" : "Response object containing unhealthy device alerts.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "unhealthyDeviceAlerts" : { "type" : "array", "description" : "List of unhealthy device alerts", "items" : { "$ref" : "#/components/schemas/UnHealthyDeviceAlertType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_MuteNotificationsForDevicetWSRequest" : { "type" : "object", "description" : "Request object for muting notifications for a specific device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration to mute notifications in seconds", "example" : 3600, "nullable" : true } } }, "Event_MuteNotificationsForDevicetWSResponse" : { "type" : "object", "description" : "Response object for muting notifications for a specific device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_PolicyAlertGroupV2" : { "type" : "object", "description" : "Group of policy alerts V2 with time range information.", "properties" : { "endTime" : { "type" : "integer", "format" : "int64", "description" : "End time of the alert group (descending chronological order)", "example" : 1641081600000, "nullable" : true }, "policyAlerts" : { "type" : "array", "description" : "List of policy alerts V2 in the group", "items" : { "$ref" : "#/components/schemas/PolicyAlertV2Type" }, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time of the alert group (descending chronological order)", "example" : 1640995200000, "nullable" : true } } }, "Event_ReportBadPolicyAlertWSRequest" : { "type" : "object", "description" : "Request object for reporting a bad policy alert.", "properties" : { "policyAlert" : { "$ref" : "#/components/schemas/PolicyAlertV2Type" } } }, "Event_ReportBadPolicyAlertWSResponse" : { "type" : "object", "description" : "Response object for reporting a bad policy alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_RuuidWrapper" : { "type" : "object", "description" : "Wrapper object containing UUIDs for alerts and events.", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_SavePolicyAlertWSRequest" : { "type" : "object", "description" : "Request object for saving a policy alert as a clip.", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "fisheyePresentationMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", "nullable" : true }, "savedClipDescription" : { "type" : "string", "description" : "Description for the saved clip", "example" : "Motion detected at main entrance", "nullable" : true }, "savedClipTitle" : { "type" : "string", "description" : "Title for the saved clip", "example" : "Security Incident - Motion Detected", "nullable" : true } } }, "Event_SavePolicyAlertWSResponse" : { "type" : "object", "description" : "Response object for saving a policy alert as a clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_SavedClipWithProgressType" : { "type" : "object", "description" : "Saved clip with progress information for processing operations.", "properties" : { "accessSettings" : { "$ref" : "#/components/schemas/ClipAccessSettings" }, "alterMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlteredView" }, "nullable" : true }, "nullable" : true }, "analyzed" : { "type" : "boolean", "nullable" : true }, "byteCount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "clipLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "clipLocationV2" : { "type" : "string", "nullable" : true }, "consoleDelete" : { "type" : "boolean", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "currentOperation" : { "type" : "string", "description" : "Current operation being performed on the clip", "example" : "Processing video", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "deviceIntervalMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TimeInterval" }, "nullable" : true }, "nullable" : true }, "devicePresentationOrder" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "deviceUuidMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "nullable" : true }, "deviceUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "externalTransactionId" : { "type" : "string", "nullable" : true }, "fisheyeHardware" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "fisheyeMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, "nullable" : true }, "integrationUploadList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "nullable" : true }, "isMonitoringClip" : { "type" : "boolean", "nullable" : true }, "isVendorClip" : { "type" : "boolean", "nullable" : true }, "lastUpdatedSec" : { "type" : "integer", "format" : "int64", "description" : "Last update timestamp in seconds", "example" : 1640995200, "nullable" : true }, "mountingDirection" : { "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "percentComplete" : { "type" : "integer", "format" : "int32", "description" : "Percentage of completion for the current operation", "example" : 75, "nullable" : true }, "placeholder" : { "type" : "boolean", "nullable" : true }, "sendToSharedStorage" : { "type" : "boolean", "nullable" : true }, "sha256Hex" : { "type" : "string", "nullable" : true }, "sourceAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/ClipStatusEnum" }, "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, "thumbnailLocationV2" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoResolution" : { "$ref" : "#/components/schemas/Resolution" } } }, "Event_SearchMotionGridWSRequest" : { "type" : "object", "description" : "Request object for searching motion grid data.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "endTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "End time as a UNIX timestamp in seconds", "example" : 1641081600, "nullable" : true }, "searchCells" : { "type" : "array", "description" : "List of motion grid cells to include in the search", "items" : { "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, "startTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "Start time as a UNIX timestamp in seconds", "example" : 1640995200, "nullable" : true } }, "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] }, "Event_SearchMotionGridWSResponse" : { "type" : "object", "description" : "Response object containing motion grid search results.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "timeUtcSecsList" : { "type" : "array", "description" : "List of timestamps where motion was detected in the specified cells", "items" : { "type" : "integer", "format" : "int64", "description" : "List of timestamps where motion was detected in the specified cells", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_SearchMotionGridWithActivitiesWSRequest" : { "type" : "object", "description" : "Request object for searching motion grid data with activity information.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "endTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "End time as a UNIX timestamp in seconds", "example" : 1641081600, "nullable" : true }, "searchCells" : { "type" : "array", "description" : "List of motion grid cells to include in the search", "items" : { "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, "startTimeUtcSecs" : { "type" : "integer", "format" : "int64", "description" : "Start time as a UNIX timestamp in seconds", "example" : 1640995200, "nullable" : true } }, "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] }, "Event_SearchMotionGridWithActivitiesWSResponse" : { "type" : "object", "description" : "Response object containing motion grid search results with activity information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "timeUtcSecsToActivityMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" }, "description" : "Map of timestamps to motion grid activities", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" : { "type" : "object", "description" : "Activity information with object ID.", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "objectId" : { "type" : "integer", "format" : "int32", "description" : "Object ID associated with the activity", "example" : 123, "nullable" : true } } }, "Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" : { "type" : "object", "description" : "Motion grid activity information for a specific timestamp.", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "activitiesWithId" : { "type" : "array", "description" : "List of activities with object IDs", "items" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" }, "nullable" : true }, "bestTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Best timestamp in milliseconds for the activity", "example" : 1640995200000, "nullable" : true } } }, "Event_UnSavePolicyAlertWSRequest" : { "type" : "object", "description" : "Request object for unsaving a policy alert (deprecated).", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "savedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_UnSavePolicyAlertWSResponse" : { "type" : "object", "description" : "Response object for unsaving a policy alert (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_UpdatePolicyAlertTextDescriptionWSRequest" : { "type" : "object", "description" : "Request object for updating the text description of a policy alert.", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "textDescription" : { "type" : "string", "description" : "Text description for the policy alert", "example" : "Motion detected at main entrance", "nullable" : true } } }, "Event_UpdatePolicyAlertTextDescriptionWSResponse" : { "type" : "object", "description" : "Response object for updating the text description of a policy alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_UpdateSavedClipWSRequest" : { "type" : "object", "description" : "Request object for updating a saved clip.", "properties" : { "accessSettings" : { "$ref" : "#/components/schemas/ClipAccessSettings" }, "description" : { "type" : "string", "description" : "Updated description for the saved clip", "example" : "Updated description of the security incident", "nullable" : true }, "savedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "title" : { "type" : "string", "description" : "Updated title for the saved clip", "example" : "Updated Security Incident", "nullable" : true } }, "required" : [ "savedClipUuid" ] }, "Event_UpdateSavedClipWSResponse" : { "type" : "object", "description" : "Response object for updating a saved clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_UpdateSharedClipGroupWSRequest" : { "type" : "object", "description" : "Request object for updating a shared clip group.", "properties" : { "description" : { "type" : "string", "description" : "Description for the shared clip group", "example" : "Updated description of the security incident", "nullable" : true }, "expirationTimeSecs" : { "type" : "integer", "format" : "int32", "nullable" : true, "writeOnly" : true }, "plaintextPassword" : { "type" : "string", "description" : "Password for accessing the shared clip group", "example" : "newpassword123", "nullable" : true }, "sharedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the shared clip group", "example" : "Updated Security Incident", "nullable" : true } } }, "Event_UpdateSharedClipGroupWSResponse" : { "type" : "object", "description" : "Response object for updating a shared clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "shareUrl" : { "type" : "string", "description" : "URL for accessing the updated shared clip group", "example" : "https://share.rhombus.com/clips/abc123", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_groups_CreateClipGroupWSRequest" : { "type" : "object", "description" : "Request object for creating a clip group.", "properties" : { "description" : { "type" : "string", "description" : "Description for the clip group", "example" : "Motion detected at main entrance", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the clip group", "example" : "Security Incident - Main Entrance", "nullable" : true }, "uuids" : { "type" : "array", "description" : "List of UUIDs for clips to include in the group", "items" : { "$ref" : "#/components/schemas/Event_RuuidWrapper" }, "nullable" : true } } }, "Event_groups_CreateClipGroupWSResponse" : { "type" : "object", "description" : "Response object for creating a clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_groups_DeleteClipGroupWSRequest" : { "type" : "object", "description" : "Request object for deleting a clip group.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_groups_DeleteClipGroupWSResponse" : { "type" : "object", "description" : "Response object for deleting a clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_groups_GetClipGroupDetailsWSRequest" : { "type" : "object", "description" : "Request object for retrieving detailed information about a clip group.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Event_groups_GetClipGroupDetailsWSResponse" : { "type" : "object", "description" : "Response object containing detailed information about a clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "group" : { "$ref" : "#/components/schemas/ClipGroupWithDetailsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_groups_GetClipGroupsForOrgWSRequest" : { "type" : "object", "description" : "Request object for retrieving clip groups for an organization with date filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for clip groups created after this timestamp", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Filter for clip groups created before this timestamp", "example" : 1641081600000, "nullable" : true } } }, "Event_groups_GetClipGroupsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing clip groups for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "groups" : { "type" : "array", "description" : "List of clip groups for the organization", "items" : { "$ref" : "#/components/schemas/ClipGroupType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_groups_UpdateClipGroupWSRequest" : { "type" : "object", "description" : "Request object for updating a clip group.", "properties" : { "description" : { "type" : "string", "description" : "Description for the clip group", "example" : "Updated description of the security incident", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the clip group", "example" : "Updated Security Incident", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuids" : { "type" : "array", "description" : "List of UUIDs for clips to include in the group", "items" : { "$ref" : "#/components/schemas/Event_RuuidWrapper" }, "nullable" : true } } }, "Event_groups_UpdateClipGroupWSResponse" : { "type" : "object", "description" : "Response object for updating a clip group.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_AddThreatCaseActionTimelineEntriesWSRequest" : { "type" : "object", "description" : "Request object for adding threat case action entries to a report's timeline.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid" ] }, "Event_incident_AddThreatCaseActionTimelineEntriesWSResponse" : { "type" : "object", "description" : "Response object for adding threat case action entries to a report's timeline.", "properties" : { "addedCount" : { "type" : "integer", "format" : "int32", "description" : "How many entries were added. Entries already on the timeline are not added again.", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateClipTimelineEntryWSRequest" : { "type" : "object", "description" : "Request object for creating an incident report timeline entry from a saved clip.", "properties" : { "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "clipUuid", "reportUuid" ] }, "Event_incident_CreateClipTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for creating an incident report timeline entry from a saved clip.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateEventTimelineEntryWSRequest" : { "type" : "object", "description" : "Request object for creating an incident report timeline entry from an event.", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "customActivityDescription" : { "type" : "string", "description" : "Custom description for the activity.", "example" : "A person was detected in the camera view", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "description" : "Custom display name for the activity.", "example" : "Person Detected", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subjectEntityName" : { "type" : "string", "description" : "Name of the person or entity the event is about, for example an identified individual.", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the event occurred, in milliseconds since the epoch.", "nullable" : true } }, "required" : [ "deviceUuid", "reportUuid", "timestampMs" ] }, "Event_incident_CreateEventTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for creating an incident report timeline entry from an event.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateIncidentReportAnnotationWSRequest" : { "type" : "object", "description" : "Request object for creating an annotation on an incident report timeline entry.", "properties" : { "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "position" : { "$ref" : "#/components/schemas/AnnotationPosition" }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the annotation.", "maxLength" : 5000, "nullable" : true } }, "required" : [ "entryUuid", "reportUuid", "text" ] }, "Event_incident_CreateIncidentReportAnnotationWSResponse" : { "type" : "object", "description" : "Response object for creating an annotation on an incident report timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportAnnotation" : { "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateIncidentReportNoteWSRequest" : { "type" : "object", "description" : "Request object for creating a note on an incident report.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the note.", "maxLength" : 5000, "nullable" : true } }, "required" : [ "reportUuid", "text" ] }, "Event_incident_CreateIncidentReportNoteWSResponse" : { "type" : "object", "description" : "Response object for creating a note on an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportNote" : { "$ref" : "#/components/schemas/IncidentReportNote" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateIncidentReportWSRequest" : { "type" : "object", "description" : "Request object for creating an incident report.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "title" : { "type" : "string", "description" : "Title of the incident report.", "maxLength" : 200, "nullable" : true } }, "required" : [ "title" ] }, "Event_incident_CreateIncidentReportWSResponse" : { "type" : "object", "description" : "Response object for creating an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReport" : { "$ref" : "#/components/schemas/IncidentReport" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreatePolicyAlertTimelineEntryWSRequest" : { "type" : "object", "description" : "Request object for creating an incident report timeline entry from an alert.", "properties" : { "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "alertUuid", "reportUuid" ] }, "Event_incident_CreatePolicyAlertTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for creating an incident report timeline entry from an alert.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_CreateSnapshotTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for creating an incident report timeline entry from an uploaded snapshot.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_DeleteIncidentReportAnnotationWSRequest" : { "type" : "object", "description" : "Request object for deleting an annotation from an incident report timeline entry.", "properties" : { "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "entryUuid", "reportUuid", "uuid" ] }, "Event_incident_DeleteIncidentReportAnnotationWSResponse" : { "type" : "object", "description" : "Response object for deleting an annotation from an incident report timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_DeleteIncidentReportNoteWSRequest" : { "type" : "object", "description" : "Request object for deleting an incident report note.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid", "uuid" ] }, "Event_incident_DeleteIncidentReportNoteWSResponse" : { "type" : "object", "description" : "Response object for deleting an incident report note.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_DeleteIncidentReportWSRequest" : { "type" : "object", "description" : "Request object for deleting an incident report.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Event_incident_DeleteIncidentReportWSResponse" : { "type" : "object", "description" : "Response object for deleting an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_DeleteTimelineEntryWSRequest" : { "type" : "object", "description" : "Request object for deleting an incident report timeline entry.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid", "uuid" ] }, "Event_incident_DeleteTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for deleting an incident report timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindIncidentReportAnnotationsByEntryWSRequest" : { "type" : "object", "description" : "Request object for retrieving all annotations for a timeline entry.", "properties" : { "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "entryUuid", "reportUuid" ] }, "Event_incident_FindIncidentReportAnnotationsByEntryWSResponse" : { "type" : "object", "description" : "Response object for retrieving all annotations for a timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportAnnotations" : { "type" : "array", "description" : "All annotations for the timeline entry.", "items" : { "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindIncidentReportAnnotationsByReportWSRequest" : { "type" : "object", "description" : "Request object for retrieving all annotations for an incident report.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid" ] }, "Event_incident_FindIncidentReportAnnotationsByReportWSResponse" : { "type" : "object", "description" : "Response object for retrieving all annotations for an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportAnnotations" : { "type" : "array", "description" : "All annotations for the incident report.", "items" : { "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindIncidentReportNotesByReportWSRequest" : { "type" : "object", "description" : "Request object for retrieving all notes for an incident report.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid" ] }, "Event_incident_FindIncidentReportNotesByReportWSResponse" : { "type" : "object", "description" : "Response object for retrieving all notes for an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportNotes" : { "type" : "array", "description" : "All notes for the incident report.", "items" : { "$ref" : "#/components/schemas/IncidentReportNote" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindIncidentReportsByOrgWSRequest" : { "type" : "object", "description" : "Request object for retrieving all incident reports for an organization.", "properties" : { "filter" : { "$ref" : "#/components/schemas/IncidentReportFilter" }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Event_incident_FindIncidentReportsByOrgWSResponse" : { "type" : "object", "description" : "Response object for retrieving all incident reports for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReports" : { "type" : "array", "description" : "All incident reports for the organization.", "items" : { "$ref" : "#/components/schemas/IncidentReport" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of results. Absent when there are no further pages.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindIncidentReportsByThreatCaseWSRequest" : { "type" : "object", "description" : "Request object for retrieving incident reports linked to a threat case.", "properties" : { "systemGenerated" : { "type" : "boolean", "description" : "If set, restricts the results to only system-generated (true) or only user-generated (false) reports linked to the threat case.", "nullable" : true }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "threatCaseUuid" ] }, "Event_incident_FindIncidentReportsByThreatCaseWSResponse" : { "type" : "object", "description" : "Response object for retrieving incident reports linked to a threat case.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReports" : { "type" : "array", "description" : "Incident reports linked to the threat case.", "items" : { "$ref" : "#/components/schemas/IncidentReport" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_FindTimelineEntriesByReportWSRequest" : { "type" : "object", "description" : "Request object for retrieving all timeline entries for an incident report.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid" ] }, "Event_incident_FindTimelineEntriesByReportWSResponse" : { "type" : "object", "description" : "Response object for retrieving all timeline entries for an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "redactedEntryUuids" : { "type" : "array", "description" : "UUIDs of entries that were redacted because the caller does not have access to them.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "timelineEntries" : { "type" : "array", "description" : "The report's timeline entries.", "items" : { "$ref" : "#/components/schemas/BaseTimelineEntry" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_GetIncidentReportAnnotationWSRequest" : { "type" : "object", "description" : "Request object for retrieving an incident report annotation.", "properties" : { "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "entryUuid", "reportUuid", "uuid" ] }, "Event_incident_GetIncidentReportAnnotationWSResponse" : { "type" : "object", "description" : "Response object for retrieving an incident report annotation.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportAnnotation" : { "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_GetIncidentReportNoteWSRequest" : { "type" : "object", "description" : "Request object for retrieving an incident report note.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid", "uuid" ] }, "Event_incident_GetIncidentReportNoteWSResponse" : { "type" : "object", "description" : "Response object for retrieving an incident report note.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportNote" : { "$ref" : "#/components/schemas/IncidentReportNote" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_GetIncidentReportWSRequest" : { "type" : "object", "description" : "Request object for retrieving an incident report.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Event_incident_GetIncidentReportWSResponse" : { "type" : "object", "description" : "Response object for retrieving an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReport" : { "$ref" : "#/components/schemas/IncidentReport" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_GetTimelineEntryWSRequest" : { "type" : "object", "description" : "Request object for retrieving an incident report timeline entry.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid", "uuid" ] }, "Event_incident_GetTimelineEntryWSResponse" : { "type" : "object", "description" : "Response object for retrieving an incident report timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "redactedEntryUuids" : { "type" : "array", "description" : "UUIDs of entries that were redacted because the caller does not have access to them.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "timelineEntry" : { "$ref" : "#/components/schemas/BaseTimelineEntry" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_RemoveThreatCaseActionTimelineEntriesWSRequest" : { "type" : "object", "description" : "Request object for removing the threat case action entries from a report's timeline.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid" ] }, "Event_incident_RemoveThreatCaseActionTimelineEntriesWSResponse" : { "type" : "object", "description" : "Response object for removing the threat case action entries from a report's timeline.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "removedCount" : { "type" : "integer", "format" : "int32", "description" : "How many entries were removed.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_ShareIncidentReportWSRequest" : { "type" : "object", "description" : "Request object for emailing a link to an incident report.", "properties" : { "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxItems" : 50, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "userUuids", "uuid" ] }, "Event_incident_ShareIncidentReportWSResponse" : { "type" : "object", "description" : "Response object for emailing a link to an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedUserUuids" : { "type" : "array", "description" : "UUIDs of the users the report could not be emailed to. Empty when every send succeeded.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_UpdateIncidentReportAnnotationWSRequest" : { "type" : "object", "description" : "Request object for updating an annotation on an incident report timeline entry.", "properties" : { "selectiveUpdate" : { "$ref" : "#/components/schemas/IncidentReportAnnotationSelectiveUpdate" } }, "required" : [ "selectiveUpdate" ] }, "Event_incident_UpdateIncidentReportAnnotationWSResponse" : { "type" : "object", "description" : "Response object for updating an annotation on an incident report timeline entry.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportAnnotation" : { "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_UpdateIncidentReportNoteWSRequest" : { "type" : "object", "description" : "Request object for updating an incident report note.", "properties" : { "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the note.", "maxLength" : 5000, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "reportUuid", "text", "uuid" ] }, "Event_incident_UpdateIncidentReportNoteWSResponse" : { "type" : "object", "description" : "Response object for updating an incident report note.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReportNote" : { "$ref" : "#/components/schemas/IncidentReportNote" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Event_incident_UpdateIncidentReportWSRequest" : { "type" : "object", "description" : "Request object for updating an incident report. Only non-null fields are applied.", "properties" : { "status" : { "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, "title" : { "type" : "string", "description" : "Title for the incident report.", "maxLength" : 200, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Event_incident_UpdateIncidentReportWSResponse" : { "type" : "object", "description" : "Response object for updating an incident report.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "incidentReport" : { "$ref" : "#/components/schemas/IncidentReport" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Eventsearch_CombinedSeekPointType" : { "type" : "object", "description" : "Combined seekpoint type containing information from various event sources including timestamps, activities, and metadata.", "properties" : { "activity" : { "$ref" : "#/components/schemas/ActivityEnum" }, "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "cardholderName" : { "type" : "string", "description" : "Cardholder (badge holder) name for OnGuard integration seekpoints", "example" : "Jane Doe", "nullable" : true }, "customActivityColor" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "customActivityDescription" : { "type" : "string", "description" : "Custom description for the activity", "example" : "A person was detected in the camera view", "nullable" : true }, "customActivityDisplayName" : { "type" : "string", "description" : "Custom display name for the activity", "example" : "Person Detected", "nullable" : true }, "dwelling" : { "type" : "boolean", "description" : "Whether the detected person is dwelling/loitering", "nullable" : true }, "faceName" : { "type" : "string", "description" : "Name of the face detected in this seekpoint", "example" : "John Doe", "nullable" : true }, "licensePlate" : { "type" : "string", "description" : "License plate detected in this seekpoint", "example" : "ABC123", "nullable" : true }, "objectId" : { "type" : "integer", "format" : "int32", "description" : "Object ID for tracking purposes", "example" : 12345, "nullable" : true }, "originalEvent" : { "type" : "object", "description" : "Original event object that generated this seekpoint", "nullable" : true }, "regionMatchTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds of the earliest motion evidence inside the searched region for this seekpoint. Only populated when the request includes searchCells and this seekpoint matched the region. May trail timestampMs, which reflects the start of the underlying motion event rather than when the region was entered.", "example" : 1640995215000, "nullable" : true }, "seekpointEndTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for the seekpoint duration", "example" : 1640995300000, "nullable" : true }, "seekpointStartTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for the seekpoint duration", "example" : 1640995200000, "nullable" : true }, "stableTrackId" : { "type" : "integer", "format" : "int32", "description" : "Stable track ID for re-identification across track segments", "example" : 42, "nullable" : true }, "thumbnailUrl" : { "type" : "string", "description" : "URL to the thumbnail image for this seekpoint", "example" : "https://example.com/thumbnail.jpg", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp in milliseconds when the seekpoint occurred", "example" : 1640995200000, "nullable" : true }, "unidentifiedFaceId" : { "type" : "string", "description" : "ID for unidentified faces", "example" : "face_12345", "nullable" : true } } }, "Eventsearch_GetCameraOrDoorbellCameraSeekpointsWSResponse" : { "type" : "object", "description" : "Response object containing seekpoints from camera or doorbell camera events.", "properties" : { "combinedSeekpoints" : { "type" : "array", "description" : "List of combined seekpoints from camera or doorbell camera events", "items" : { "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Eventsearch_GetEventSeekpointsByStableTrackIdWSRequest" : { "type" : "object", "description" : "Request object for retrieving event seekpoints filtered by stable track IDs.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "Set of device facet uuids to retrieve footage seekpoints for.", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds since the start time to retrieve seekpoints for.", "nullable" : true }, "stableTrackIds" : { "type" : "array", "description" : "Set of stable track IDs to filter seekpoints by.", "items" : { "type" : "integer", "format" : "int32", "description" : "Set of stable track IDs to filter seekpoints by.", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", "nullable" : true } }, "required" : [ "deviceUuids", "durationSec", "stableTrackIds", "startTimeSec" ] }, "Eventsearch_GetEventSeekpointsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving event seekpoints V2 with enhanced filtering and clustering options.", "properties" : { "accessControlledDoorUuids" : { "type" : "array", "description" : "Set of access controlled door uuids to retrieve component seekpoints for.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "activityFilter" : { "type" : "array", "description" : "Optional filter to specify what activities are returned.", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "clothingColorFilter" : { "type" : "array", "description" : "Optional filter to specify which human motion seekpoints are returned.", "items" : { "$ref" : "#/components/schemas/ColorEnum" }, "nullable" : true, "uniqueItems" : true }, "clusterIntervalSec" : { "type" : "integer", "format" : "int32", "description" : "An optional interval X (in seconds) that, when specified, causes this endpoint to return a smaller collection of seekpoints. These seekpoints represent clusters of activities that occur consecutively within X seconds of each other.", "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "Set of device facet uuids to retrieve footage seekpoints for.", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds since the start time to retrieve seekpoints for.", "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "default" : false, "description" : "Determines whether or not any motion seekpoints are returned.", "nullable" : true }, "includeIntegrationEvents" : { "type" : "boolean", "default" : false, "description" : "Determines whether or not to include any seekpoints from enabled integrations.", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rawInactivitySeekpoints" : { "type" : "boolean", "description" : "When true, INACTIVITY_* seekpoints are returned as the raw start, fire and resolve instants of each window (sharing the window's objectId) instead of one clustered row per window. Defaults to false.", "nullable" : true }, "searchCells" : { "type" : "array", "description" : "Optional filter used to limit the seekpoint search to the region provided.", "items" : { "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", "nullable" : true }, "vehicleColorFilter" : { "type" : "array", "description" : "Optional filter to specify which vehicle motion seekpoints are returned.", "items" : { "$ref" : "#/components/schemas/ColorEnum" }, "nullable" : true, "uniqueItems" : true } }, "required" : [ "durationSec", "startTimeSec" ] }, "Eventsearch_GetEventSeekpointsWSRequest" : { "type" : "object", "description" : "Request object for retrieving event seekpoints with various search criteria and filtering options.", "properties" : { "activitySet" : { "type" : "array", "description" : "Set of activity types to filter seekpoints by", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "componentSeekPointsByAccessControlledDoorWSRequest" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" }, "componentSeekPointsByAccessControlledDoorsWSRequest" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" }, "componentSeekPointsByOwnerDeviceWSRequest" : { "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByOwnerDeviceWSRequest" }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds for the search window", "example" : 3600, "nullable" : true }, "searchColorAndVehicleByColorWSRequest" : { "$ref" : "#/components/schemas/Eventsearch_SearchClothingAndVehicleByColorWSRequest" }, "searchMotionGridWithActivitiesWSRequest" : { "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSRequest" }, "seekpointsWSRequest" : { "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSRequest" }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds for the search window", "example" : 1640995200, "nullable" : true }, "videoFootageWSRequest" : { "$ref" : "#/components/schemas/Eventsearch_VideoFootageWSRequest" } } }, "Eventsearch_GetEventSeekpointsWSResponse" : { "type" : "object", "description" : "Response object containing combined seekpoints from various event sources.", "properties" : { "combinedSeekpoints" : { "type" : "array", "description" : "List of combined seekpoints from various event sources", "items" : { "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Eventsearch_SearchClothingAndVehicleByColorWSRequest" : { "type" : "object", "description" : "Request object for searching clothing and vehicle events by color with time and device filtering.", "properties" : { "clothingColorFilter" : { "type" : "array", "description" : "Set of clothing colors to filter the search by", "items" : { "$ref" : "#/components/schemas/ColorEnum" }, "nullable" : true, "uniqueItems" : true }, "deviceFilter" : { "type" : "array", "description" : "List of device UUIDs to filter the search by", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for the search window", "example" : 1641081600000, "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for the search window", "example" : 1640995200000, "nullable" : true }, "vehicleColorFilter" : { "type" : "array", "description" : "Set of vehicle colors to filter the search by", "items" : { "$ref" : "#/components/schemas/ColorEnum" }, "nullable" : true, "uniqueItems" : true } } }, "Eventsearch_SearchIntegrationAccessEventsWSRequest" : { "type" : "object", "description" : "Filters for searching access events from third-party access-control integrations (e.g. Honeywell OnGuard or Honeywell Elements) — distinct from native Rhombus access control. All filters are optional; results are scoped to the caller's org and to the dedicated integration access-event types. Use activityTypes to scope to a specific integration's events (e.g. the ELEMENTS_* set or the ONGUARD_* set); leave it empty to search all integration access events.", "properties" : { "activityTypes" : { "type" : "array", "description" : "Dedicated access-control activity types to scope results to (e.g. the ELEMENTS_* set or the ONGUARD_* set). If null or empty, results are scoped to all dedicated access-control activity types.", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "afterMs" : { "type" : "integer", "format" : "int64", "description" : "Only events at or after this time (epoch ms)", "example" : 1640995200000, "nullable" : true }, "anomalyOnly" : { "type" : "boolean", "description" : "Only return anomaly (alerting) events — inactive badge / no entry made", "nullable" : true }, "area" : { "type" : "string", "description" : "Filter by the area being entered", "example" : "Lobby", "nullable" : true }, "badgeStatus" : { "type" : "string", "description" : "Filter by badge status", "example" : "Active", "nullable" : true }, "badgeType" : { "type" : "string", "description" : "Filter by badge type", "nullable" : true }, "beforeMs" : { "type" : "integer", "format" : "int64", "description" : "Only events at or before this time (epoch ms)", "example" : 1640998800000, "nullable" : true }, "cardholderQuery" : { "type" : "string", "description" : "Full-text match on the cardholder name (stored in the seekpoint description)", "example" : "Lisa Lake", "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "Limit results to these camera/device UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "entryMade" : { "type" : "boolean", "description" : "Filter by whether access was granted AND entry was made (false = possible tailgating)", "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Max results to return (server caps at 1000)", "example" : 100, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "Limit results to these location UUIDs", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Eventsearch_SearchIntegrationAccessEventsWSResponse" : { "type" : "object", "description" : "Matching third-party integration access events (footage seekpoints), newest first.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "events" : { "type" : "array", "description" : "Matching integration access events. Each carries timestamp, device/location, the event label (customDisplayName), the cardholder name, badge status/type, entering/exiting area, entryMade, and alert (anomaly) flag.", "items" : { "$ref" : "#/components/schemas/SeekpointIndexType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Eventsearch_VideoFootageWSRequest" : { "type" : "object", "description" : "Request object for video footage search with camera selection and multi-camera options.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "cameraUuids" : { "type" : "array", "description" : "List of camera UUIDs to search for video footage", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "duration" : { "type" : "integer", "format" : "int32", "description" : "Duration in seconds", "example" : 3600, "nullable" : true }, "includeAnyMotion" : { "type" : "boolean", "description" : "Whether to include any motion events", "example" : true, "nullable" : true }, "startTime" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds since epoch", "example" : 1640995200, "nullable" : true }, "useMultiCamera" : { "type" : "boolean", "description" : "Whether to use multi-camera search functionality", "example" : true, "nullable" : true } } }, "ExampleImage" : { "type" : "object", "properties" : { "image" : { "type" : "string", "nullable" : true }, "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "label" : { "type" : "string", "nullable" : true } } }, "ExistingGuestPassCredentialAssignment" : { "type" : "object", "description" : "Hex value of an existing credential to assign to the new guest pass.", "properties" : { "credentialHexValue" : { "type" : "string", "description" : "Hex value of the credential to assign. Must resolve to an existing, currently-unassigned credential in the same org.", "nullable" : true } }, "required" : [ "credentialHexValue" ] }, "Export_ExportAlertMonitoringEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting an alarm monitoring events log.", "properties" : { "filter" : { "$ref" : "#/components/schemas/ALMEventFilter" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "minimal" : { "type" : "boolean", "default" : false, "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, "principalName" : { "type" : "string", "description" : "Case-insensitive principal name, used when scope is PRINCIPAL and no principalUuid is set.", "nullable" : true }, "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scope" : { "$ref" : "#/components/schemas/Export_ExportAlertMonitoringEventsWSRequest_Scope" }, "sortAscending" : { "type" : "boolean", "default" : false, "description" : "If true, return events in ascending timestamp order.", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, "required" : [ "scope" ] }, "Export_ExportAlertMonitoringEventsWSRequest_Scope" : { "type" : "string", "default" : "ORG", "description" : "Scope to export events for.", "enum" : [ "ORG", "LOCATION", "SUB_LOCATION", "PRINCIPAL" ] }, "Export_ExportAuditEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting audit events to CSV format with filtering options.", "properties" : { "endInterval" : { "type" : "integer", "format" : "int64", "description" : "End time interval in milliseconds for filtering audit events", "example" : 1641081600000, "nullable" : true }, "excludeActions" : { "type" : "array", "description" : "If not empty, events with actions specified in the list are filtered out. If both include and exclude actions are specified, exclude actions are ignored.", "items" : { "$ref" : "#/components/schemas/AuditActionEnum" }, "nullable" : true }, "includeActions" : { "type" : "array", "description" : "If not empty, only events with actions specified in the list are included. If both include and exclude actions are specified, exclude actions are ignored.", "items" : { "$ref" : "#/components/schemas/AuditActionEnum" }, "nullable" : true }, "startInterval" : { "type" : "integer", "format" : "int64", "description" : "Start time interval in milliseconds for filtering audit events", "example" : 1640995200000, "nullable" : true } } }, "Export_ExportClimateEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting climate sensor events with time filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering climate events", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering climate events", "example" : 1641081600000, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Export_ExportCountReportsWSRequest" : { "type" : "object", "description" : "Request object for exporting count reports with configurable intervals, scopes, and time ranges.", "properties" : { "endDate" : { "type" : "string", "deprecated" : true, "description" : "Enter the ending date in in ISO 8601 format", "example" : "2024-07-17T00:00:00Z", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End datetime as a UNIX timestamp in milliseconds", "example" : 1721416242907, "minimum" : 0, "nullable" : true }, "interval" : { "$ref" : "#/components/schemas/ReportIntervalEnum" }, "scope" : { "$ref" : "#/components/schemas/ReportScopeEnum" }, "startDate" : { "type" : "string", "deprecated" : true, "description" : "Enter the starting date in ISO 8601 format", "example" : "2024-07-17T00:00:00Z", "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start datetime as a UNIX timestamp in milliseconds", "example" : 1719861042000, "minimum" : 0, "nullable" : true }, "timeZone" : { "type" : "string", "description" : "String of timezone for bucketing", "example" : "America/Los_Angeles", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ReportTypeEnum" }, "uuidList" : { "type" : "array", "description" : "Enter the UUID of device(s) or location(s)", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true } }, "required" : [ "endTimeMs", "interval", "scope", "startTimeMs", "type" ] }, "Export_ExportDiagnosticEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting diagnostic events with time interval filtering.", "properties" : { "endInterval" : { "type" : "integer", "format" : "int64", "description" : "End time interval in milliseconds for filtering diagnostic events", "example" : 1641081600000, "nullable" : true }, "startInterval" : { "type" : "integer", "format" : "int64", "description" : "Start time interval in milliseconds for filtering diagnostic events", "example" : 1640995200000, "nullable" : true } } }, "Export_ExportDoorEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting door sensor events with time filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering door events", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering door events", "example" : 1641081600000, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Export_ExportEnvironmentalGatewayEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting environmental gateway events with time filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering environmental gateway events", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering environmental gateway events", "example" : 1641081600000, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Export_ExportInventoryWSRequest" : { "type" : "object", "description" : "Request object for exporting device inventory information to CSV format.", "properties" : { "cameraUuids" : { "type" : "array", "deprecated" : true, "description" : "List of camera UUIDs to export (deprecated, use deviceUuids instead)", "items" : { "type" : "string", "format" : "RUUID", "deprecated" : true, "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to export inventory for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Export_ExportMotionEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting motion events from motion sensors with time filtering.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "After datetime provided as a UNIX timestamp in milliseconds", "example" : 1640995200000, "minimum" : 0, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Before datetime provided as a UNIX timestamp in milliseconds", "example" : 1641081600000, "minimum" : 0, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "deviceUuid" ] }, "Export_ExportPeopleCountEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting people count events with time interval filtering.", "properties" : { "endInterval" : { "type" : "integer", "format" : "int64", "description" : "End time interval in milliseconds for filtering people count events", "example" : 1641081600000, "nullable" : true }, "startInterval" : { "type" : "integer", "format" : "int64", "description" : "Start time interval in milliseconds for filtering people count events", "example" : 1640995200000, "nullable" : true } } }, "Export_ExportProximityEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting proximity events with time filtering and tag selection.", "properties" : { "createBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true, "writeOnly" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering proximity events", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering proximity events", "example" : 1641081600000, "nullable" : true }, "tagUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Export_ExportProximityLocomotionEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting proximity locomotion events with time filtering and tag selection.", "properties" : { "createBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true, "writeOnly" : true }, "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering proximity locomotion events", "example" : 1640995200000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering proximity locomotion events", "example" : 1641081600000, "nullable" : true }, "tagUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Export_ExportUptimeWSRequest" : { "type" : "object", "description" : "Request object for exporting device uptime reports with configurable time ranges and granularity.", "properties" : { "cameraUuids" : { "type" : "array", "deprecated" : true, "description" : "Use deviceUuids instead", "items" : { "type" : "string", "format" : "RUUID", "deprecated" : true, "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to export uptime reports for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "endDateTime" : { "type" : "string", "description" : "End date and time for the uptime report", "example" : "2024-01-31T23:59:59Z", "nullable" : true }, "granularity" : { "$ref" : "#/components/schemas/JavaTimeUnitEnum" }, "startDateTime" : { "type" : "string", "description" : "Start date and time for the uptime report", "example" : "2024-01-01T00:00:00Z", "nullable" : true } } }, "Export_ExportUsersWSRequest" : { "type" : "object", "description" : "Request object for exporting user information to CSV format.", "properties" : { "userUuids" : { "type" : "array", "description" : "List of user UUIDs to export information for", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Export_ExportVehicleEventsWSRequest" : { "type" : "object", "description" : "Request object for exporting vehicle events with filtering by time, devices, labels, and plate numbers.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to filter vehicle events by", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "fuzzy" : { "type" : "boolean", "description" : "Whether to use fuzzy search on the provided plate numbers", "example" : true, "nullable" : true }, "interval" : { "$ref" : "#/components/schemas/TimeInterval" }, "labels" : { "type" : "array", "description" : "List of vehicle labels to filter by", "example" : [ "car", "truck", "motorcycle" ], "items" : { "type" : "string", "description" : "List of vehicle labels to filter by", "example" : "[\"car\",\"truck\",\"motorcycle\"]", "nullable" : true }, "nullable" : true }, "plateNumbers" : { "type" : "array", "description" : "List of license plate numbers to filter by", "example" : [ "ABC123", "XYZ789" ], "items" : { "type" : "string", "description" : "List of license plate numbers to filter by", "example" : "[\"ABC123\",\"XYZ789\"]", "nullable" : true }, "nullable" : true } } }, "FaceUploadMetadata" : { "type" : "object", "description" : "List of face upload metadata for the transaction", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "faceId" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "origS3Key" : { "type" : "string", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "success" : { "type" : "boolean", "nullable" : true }, "transactionId" : { "type" : "string", "nullable" : true } } }, "Facerecognition_faceevent_CreateTailgatingRuleWSRequest" : { "type" : "object", "description" : "The IntelliGuard tailgating rule to create.", "properties" : { "rule" : { "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" } } }, "Facerecognition_faceevent_DeleteFaceEventWSRequest" : { "type" : "object", "description" : "Request object for deleting a face event.", "properties" : { "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_DeleteFaceEventWSResponse" : { "type" : "object", "description" : "Response object for deleting a face event." }, "Facerecognition_faceevent_DeleteTailgatingRuleWSRequest" : { "type" : "object", "description" : "The IntelliGuard tailgating rule to delete.", "properties" : { "ruleUuid" : { "type" : "string", "description" : "Uuid of the tailgating rule to delete. Required.", "nullable" : true } } }, "Facerecognition_faceevent_DetectCoOccurrenceWSRequest" : { "type" : "object", "description" : "One recognized-face sighting to evaluate against the org's IntelliGuard co-occurrence rules in-request. The org is taken from the session; the server stamps the sighting timestamp as now.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "faceName" : { "type" : "string", "description" : "Recognized face name. At least one of faceName / personUuid is required.", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_DetectCoOccurrenceWSResponse" : { "type" : "object", "description" : "Acknowledgement for a co-occurrence detect submission. Empty by design: any alert fires server-side inside IntelliGuard, and the call is best-effort." }, "Facerecognition_faceevent_ExportFaceEventsByOrgWSRequest" : { "type" : "object", "description" : "Request object for exporting face events by organization with search filtering.", "properties" : { "searchFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" } } }, "Facerecognition_faceevent_ExternalFaceEvent" : { "type" : "object", "description" : "External face event object containing face recognition data with person matches, embeddings, and metadata.", "properties" : { "detectionConfidence" : { "type" : "number", "format" : "float", "description" : "Confidence value indicating the likelihood that the detected image is a face", "example" : 0.98, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "embeddingConfidence" : { "type" : "number", "format" : "float", "description" : "Confidence value associated with the embedding generated for the face image", "example" : 0.95, "nullable" : true }, "eventTimestamp" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the face event occurred", "example" : 1640995200000, "nullable" : true }, "faceName" : { "type" : "string", "description" : "Name of the person that matched the face image. If selectedPersonMatch is not null, faceName will be equal to the name field of selectedPersonMatch.", "nullable" : true }, "hasEmbedding" : { "type" : "boolean", "description" : "Whether the face event has an embedding", "example" : true, "nullable" : true }, "imageS3Key" : { "type" : "string", "description" : "S3 key for the face event image", "example" : "face-events/images/event_123.jpg", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "selectedPersonMatch" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "thumbnailS3Key" : { "type" : "string", "description" : "S3 key for the face event thumbnail", "example" : "face-events/thumbnails/event_123.jpg", "nullable" : true }, "topPersonMatches" : { "type" : "array", "description" : "Top person matches found for the face image.", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_ExternalFaceEventSearchFilter" : { "type" : "object", "description" : "Search filter for face events with embedding presence filtering.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "Optional filter by a set of devices.", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "faceNameContains" : { "type" : "string", "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", "nullable" : true }, "faceNames" : { "type" : "array", "description" : "Optional filter by people names.", "items" : { "type" : "string", "description" : "Optional filter by people names.", "nullable" : true }, "nullable" : true }, "hasEmbedding" : { "type" : "boolean", "description" : "Optional filter by the presence or absence of an embedding.", "nullable" : true }, "hasName" : { "type" : "boolean", "description" : "Optional filter by the presence or absence of a person name.", "nullable" : true }, "labels" : { "type" : "array", "description" : "Optional filter by labels.", "items" : { "type" : "string", "description" : "Optional filter by labels.", "nullable" : true }, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "Optional filter by a set of locations.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "personUuids" : { "type" : "array", "description" : "Optional filter by a set of people.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "timestampFilter" : { "$ref" : "#/components/schemas/TimestampFilter" } } }, "Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" : { "type" : "object", "description" : "Search filter for finding similar face events with similarity thresholds and confidence settings.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "Optional filter by a set of devices.", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "embeddingConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Optional face embedding confidence threshold used to filter out face events with embeddingconfidence values less than the specified threshold. Valid range [0,1].", "maximum" : 1, "minimum" : 0, "nullable" : true }, "faceMatchDistanceThreshold" : { "type" : "number", "format" : "float", "description" : "Optional face match distance threshold used to compare face event images. Defaults to 0.7.Valid range [0,1].", "maximum" : 1, "minimum" : 0, "nullable" : true }, "faceNameContains" : { "type" : "string", "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", "nullable" : true }, "faceNames" : { "type" : "array", "description" : "Optional filter by people names.", "items" : { "type" : "string", "description" : "Optional filter by people names.", "nullable" : true }, "nullable" : true }, "hasName" : { "type" : "boolean", "description" : "Optional filter by the presence or absence of a person name.", "nullable" : true }, "labels" : { "type" : "array", "description" : "Optional filter by labels.", "items" : { "type" : "string", "description" : "Optional filter by labels.", "nullable" : true }, "nullable" : true }, "locationUuids" : { "type" : "array", "description" : "Optional filter by a set of locations.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "personUuids" : { "type" : "array", "description" : "Optional filter by a set of people.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "timestampFilter" : { "$ref" : "#/components/schemas/TimestampFilter" } } }, "Facerecognition_faceevent_ExternalPersonMatch" : { "type" : "object", "description" : "Person match information for face recognition events with confidence scoring.", "properties" : { "confidence" : { "type" : "number", "format" : "float", "description" : "Match confidence level expressed as a value in range[0,1]", "example" : 0.95, "nullable" : true }, "faceId" : { "type" : "string", "description" : "Face ID associated with the person match", "example" : "face_12345", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the person matched", "example" : "John Doe", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_FindCoOccurrenceRulesWSResponse" : { "type" : "object", "description" : "The IntelliGuard co-occurrence rules for the caller's org (org is taken from the session).", "properties" : { "rules" : { "type" : "array", "description" : "The org's co-occurrence rules.", "items" : { "$ref" : "#/components/schemas/IntelliGuardCoOccurrenceRule" }, "nullable" : true } } }, "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSRequest" : { "type" : "object", "description" : "Request object for finding face events by device for reporting purposes with timestamp filtering and pagination.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "timestampFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSResponse" : { "type" : "object", "description" : "Response object containing face events by device for reporting purposes with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events by device for reporting purposes", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of face events by device for reporting", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSRequest" : { "type" : "object", "description" : "Request object for finding face events by location for reporting purposes with timestamp filtering and pagination.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "timestampFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSResponse" : { "type" : "object", "description" : "Response object containing face events by location for reporting purposes with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events by location for reporting purposes", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of face events by location for reporting", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSRequest" : { "type" : "object", "description" : "Request object for finding face events by organization for reporting purposes with timestamp filtering and pagination.", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "timestampFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSResponse" : { "type" : "object", "description" : "Response object containing face events for reporting purposes with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events for reporting purposes", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of face events for reporting", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindFaceEventsByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding face events by organization with search filtering and pagination.", "properties" : { "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "searchFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" } } }, "Facerecognition_faceevent_FindFaceEventsByOrgWSResponse" : { "type" : "object", "description" : "Response object containing face events for an organization with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events matching the search criteria", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of results", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSRequest" : { "type" : "object", "description" : "Request object for finding face events similar to a face embedding with search filtering and pagination.", "properties" : { "embedding" : { "$ref" : "#/components/schemas/Embedding" }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "searchFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" } } }, "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSResponse" : { "type" : "object", "description" : "Response object containing face events similar to a face embedding with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events similar to the specified face embedding", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of similar face events", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSRequest" : { "type" : "object", "description" : "Request object for finding face events similar to a face ID using face matchmaker with search filtering and pagination.", "properties" : { "faceId" : { "type" : "string", "description" : "Face ID to find similar face events for", "example" : "face_12345", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "searchFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" } } }, "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSResponse" : { "type" : "object", "description" : "Response object containing face events similar to a face ID using face matchmaker with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events similar to the specified face ID", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of similar face events", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindSimilarFaceEventsWSRequest" : { "type" : "object", "description" : "Request object for finding face events similar to a specified face event with search filtering and pagination.", "properties" : { "faceEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "searchFilter" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" } } }, "Facerecognition_faceevent_FindSimilarFaceEventsWSResponse" : { "type" : "object", "description" : "Response object containing face events similar to a specified face event with pagination information.", "properties" : { "faceEvents" : { "type" : "array", "description" : "List of face events similar to the specified face event", "items" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Pagination key for retrieving the next page of similar face events", "example" : "next_page_key_123", "nullable" : true } } }, "Facerecognition_faceevent_FindTailgatingRulesWSResponse" : { "type" : "object", "description" : "The IntelliGuard tailgating rules for the caller's org.", "properties" : { "rules" : { "type" : "array", "description" : "The org's tailgating rules.", "items" : { "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" }, "nullable" : true } } }, "Facerecognition_faceevent_GetFaceEventWSRequest" : { "type" : "object", "description" : "Request object for retrieving a specific face event by UUID.", "properties" : { "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_GetFaceEventWSResponse" : { "type" : "object", "description" : "Response object containing a specific face event.", "properties" : { "faceEvent" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" } } }, "Facerecognition_faceevent_ProcessFaceEventSearchImageWSResponse" : { "type" : "object", "description" : "Response object containing processed face search image with embedding and base64 image data.", "properties" : { "embedding" : { "$ref" : "#/components/schemas/Embedding" }, "imageBase64" : { "type" : "string", "description" : "Base64 encoded image used for embedding generation. The image in the request may have been modified(cropped) in order to generate embedding.", "nullable" : true } } }, "Facerecognition_faceevent_ReportTimestampFilter" : { "type" : "object", "description" : "Filter object for reporting face events with timestamp range and interval configuration.", "properties" : { "rangeStart" : { "type" : "string", "format" : "date-time", "description" : "Start date for the reporting range", "example" : "2024-01-01T00:00:00Z", "nullable" : true }, "reportInterval" : { "$ref" : "#/components/schemas/ReportIntervalEnum" } } }, "Facerecognition_faceevent_UpdateFaceEventWSRequest" : { "type" : "object", "description" : "Request object for updating a face event with person association information.", "properties" : { "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personName" : { "type" : "string", "description" : "Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches.", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_faceevent_UpdateFaceEventWSResponse" : { "type" : "object", "description" : "Response object for updating a face event.", "properties" : { "faceEvent" : { "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" } } }, "Facerecognition_faceevent_UpdateTailgatingRuleWSRequest" : { "type" : "object", "description" : "The IntelliGuard tailgating rule to update.", "properties" : { "rule" : { "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" } } }, "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSRequest" : { "type" : "object", "description" : "Request object for creating a face matchmaker from a face event sighting.", "properties" : { "faceEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSResponse" : { "type" : "object", "description" : "Response object for creating a face matchmaker from a face event sighting.", "properties" : { "faceMatchmaker" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" } } }, "Facerecognition_matchmaker_CreatePersonAndFaceMatchmakersWSResponse" : { "type" : "object", "description" : "Response object for creating a person and associated face matchmakers.", "properties" : { "faceMatchmakers" : { "type" : "array", "description" : "List of created face matchmakers for the person", "items" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "nullable" : true }, "person" : { "$ref" : "#/components/schemas/Person" }, "transactionId" : { "type" : "string", "description" : "Transaction ID for tracking the creation process", "example" : "txn_12345", "nullable" : true } } }, "Facerecognition_matchmaker_DeleteFaceMatchmakerWSRequest" : { "type" : "object", "description" : "Request object for deleting a face matchmaker.", "properties" : { "faceId" : { "type" : "string", "description" : "Face ID of the matchmaker to delete", "example" : "face_12345", "nullable" : true } } }, "Facerecognition_matchmaker_DeleteFaceMatchmakerWSResponse" : { "type" : "object", "description" : "Response object for deleting a face matchmaker." }, "Facerecognition_matchmaker_ExternalFaceMatchmaker" : { "type" : "object", "description" : "External face matchmaker object containing face recognition matchmaker data and metadata.", "properties" : { "createdOn" : { "type" : "string", "format" : "date-time", "description" : "Date when the face matchmaker was created", "example" : "2024-01-01T00:00:00Z", "nullable" : true }, "id" : { "type" : "string", "description" : "Unique identifier for the face matchmaker", "example" : "face_12345", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uploaded" : { "type" : "boolean", "description" : "Whether the face matchmaker has been uploaded", "example" : true, "nullable" : true } } }, "Facerecognition_matchmaker_FileUploadResult" : { "type" : "object", "description" : "Result of a file upload process for face matchmaker creation, including success status and error messages.", "properties" : { "fileName" : { "type" : "string", "description" : "The name of the uploaded file.", "nullable" : true }, "message" : { "type" : "string", "description" : "Error message that occurred during upload.", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Indicates whether the file upload was successful. Note, that even if upload was successful, subsequent operations, such as adding the uploaded file as a matchmaker, may fail.", "nullable" : true } } }, "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding face matchmakers by organization." }, "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSResponse" : { "type" : "object", "description" : "Response object containing face matchmakers for an organization.", "properties" : { "faceMatchmakers" : { "type" : "array", "description" : "List of face matchmakers for the organization", "items" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "nullable" : true } } }, "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSRequest" : { "type" : "object", "description" : "Request object for finding face matchmakers by person UUID.", "properties" : { "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSResponse" : { "type" : "object", "description" : "Response object containing face matchmakers for a specific person.", "properties" : { "faceMatchmakers" : { "type" : "array", "description" : "List of face matchmakers for the specified person", "items" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "nullable" : true } } }, "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSRequest" : { "type" : "object", "description" : "Request object for finding face upload metadata by transaction ID.", "properties" : { "transactionId" : { "type" : "string", "description" : "Transaction ID to find face upload metadata for", "example" : "txn_12345", "nullable" : true } } }, "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSResponse" : { "type" : "object", "description" : "Response object containing face upload metadata for a transaction.", "properties" : { "faceUploadMetadata" : { "type" : "array", "description" : "List of face upload metadata for the transaction", "items" : { "$ref" : "#/components/schemas/FaceUploadMetadata" }, "nullable" : true } } }, "Facerecognition_matchmaker_GetFaceMatchingConfigWSRequest" : { "type" : "object", "description" : "Request object for retrieving face matching configuration." }, "Facerecognition_matchmaker_GetFaceMatchingConfigWSResponse" : { "type" : "object", "description" : "Response object containing face matching configuration settings.", "properties" : { "faceMatchConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Face match confidence threshold value", "example" : 0.7, "nullable" : true } } }, "Facerecognition_matchmaker_GetFaceMatchmakerWSRequest" : { "type" : "object", "description" : "Request object for retrieving a face matchmaker by face ID.", "properties" : { "faceId" : { "type" : "string", "description" : "Face ID to retrieve the matchmaker for", "example" : "face_12345", "nullable" : true } } }, "Facerecognition_matchmaker_GetFaceMatchmakerWSResponse" : { "type" : "object", "description" : "Response object containing a face matchmaker.", "properties" : { "faceMatchmaker" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" } } }, "Facerecognition_matchmaker_SearchFaceMatchmakerResult" : { "type" : "object", "description" : "A single candidate face matchmaker returned from a face image search, with the confidence of the match.", "properties" : { "faceMatchmaker" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "matchConfidence" : { "type" : "number", "format" : "float", "description" : "Confidence that the supplied image is of the same person as this matchmaker, in [0.0, 1.0].", "example" : 0.93, "nullable" : true } } }, "Facerecognition_matchmaker_SearchFaceMatchmakersByImageWSResponse" : { "type" : "object", "description" : "Response object for searching face matchmakers by image. Contains ranked candidate matchmakers and metadata about the embedding generated from the supplied image.", "properties" : { "embeddingConfidence" : { "type" : "number", "format" : "float", "description" : "Confidence of the embedding generated from the supplied image. A low value indicates the image is unlikely to produce reliable matches.", "example" : 0.97, "nullable" : true }, "searchResults" : { "type" : "array", "description" : "Ranked list of candidate face matchmakers that matched the supplied image, ordered by matchConfidence descending. Empty if no candidates passed the matching threshold.", "items" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_SearchFaceMatchmakerResult" }, "nullable" : true } } }, "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSRequest" : { "type" : "object", "description" : "Request object for updating face matching configuration settings.", "properties" : { "faceMatchConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Minimum confidence level required for the system to automatically assign a match. If null, the system uses the built-in default.", "maximum" : 1.0, "minimum" : 0.0, "nullable" : true } } }, "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSResponse" : { "type" : "object", "description" : "Response object for updating face matching configuration settings.", "properties" : { "faceMatchConfidenceThreshold" : { "type" : "number", "format" : "float", "description" : "Updated face match confidence threshold value", "example" : 0.7, "nullable" : true } } }, "Facerecognition_matchmaker_UploadFaceMatchmakerForPersonWSResponse" : { "type" : "object", "description" : "Response object for uploading a face matchmaker for a specific person.", "properties" : { "fileUploadResult" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" }, "transactionId" : { "type" : "string", "description" : "Transaction ID to track face matchmaker upload progress", "example" : "txn_12345", "nullable" : true } } }, "Facerecognition_matchmaker_UploadFaceMatchmakersWSResponse" : { "type" : "object", "description" : "Response object for uploading face matchmakers with transaction tracking and upload results.", "properties" : { "fileUploadResults" : { "type" : "array", "description" : "List of file upload results for each uploaded face matchmaker", "items" : { "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" }, "nullable" : true }, "transactionId" : { "type" : "string", "description" : "Transaction ID to track face matchmakers upload progress", "example" : "txn_12345", "nullable" : true } } }, "Facerecognition_matchmaker_ValidateFaceMatchmakerImageWSResponse" : { "type" : "object", "description" : "Response object for validating face matchmaker images with validation status and error information.", "properties" : { "errorMessage" : { "type" : "string", "description" : "Error message if validation failed", "example" : "Image quality too low", "nullable" : true }, "valid" : { "type" : "boolean", "description" : "Whether the face matchmaker image is valid", "example" : true, "nullable" : true } } }, "Facerecognition_person_AddPersonLabelWSRequest" : { "type" : "object", "description" : "Request object for adding a label to a person for face recognition purposes.", "properties" : { "label" : { "type" : "string", "description" : "Label to add to the person", "example" : "VIP", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_person_AddPersonLabelWSResponse" : { "type" : "object", "description" : "Response object for adding a label to a person for face recognition purposes." }, "Facerecognition_person_CreatePersonWSRequest" : { "type" : "object", "description" : "Request object for creating a person for face recognition purposes.", "properties" : { "name" : { "type" : "string", "description" : "Name of the person to create", "example" : "John Doe", "nullable" : true } } }, "Facerecognition_person_CreatePersonWSResponse" : { "type" : "object", "description" : "Response object for creating a person for face recognition purposes.", "properties" : { "person" : { "$ref" : "#/components/schemas/Person" } } }, "Facerecognition_person_DeletePersonWSRequest" : { "type" : "object", "description" : "Request object for deleting a person for face recognition purposes.", "properties" : { "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_person_DeletePersonWSResponse" : { "type" : "object", "description" : "Response object for deleting a person for face recognition purposes." }, "Facerecognition_person_FindPeopleByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding people by organization for face recognition purposes." }, "Facerecognition_person_FindPeopleByOrgWSResponse" : { "type" : "object", "description" : "Response object containing people for an organization for face recognition purposes.", "properties" : { "people" : { "type" : "array", "description" : "List of people for the organization", "items" : { "$ref" : "#/components/schemas/Person" }, "nullable" : true } } }, "Facerecognition_person_FindPersonLabelsByOrgWSRequest" : { "type" : "object", "description" : "Request object for finding person labels by organization for face recognition purposes." }, "Facerecognition_person_FindPersonLabelsByOrgWSResponse" : { "type" : "object", "description" : "Response object containing person labels by organization for face recognition purposes.", "properties" : { "labelsByPerson" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of person UUIDs to their associated labels", "items" : { "type" : "string", "description" : "Map of person UUIDs to their associated labels", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "description" : "Map of person UUIDs to their associated labels", "nullable" : true } } }, "Facerecognition_person_GetPersonWSRequest" : { "type" : "object", "description" : "Request object for retrieving a person by UUID.", "properties" : { "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_person_GetPersonWSResponse" : { "type" : "object", "description" : "Response object containing a person.", "properties" : { "person" : { "$ref" : "#/components/schemas/Person" } } }, "Facerecognition_person_RemovePersonLabelWSRequest" : { "type" : "object", "description" : "Request object for removing a label from a person for face recognition purposes.", "properties" : { "label" : { "type" : "string", "description" : "Label to remove from the person", "example" : "VIP", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Facerecognition_person_RemovePersonLabelWSResponse" : { "type" : "object", "description" : "Response object for removing a label from a person for face recognition purposes." }, "Facerecognition_person_UpdatePersonWSRequest" : { "type" : "object", "description" : "Request object for updating a person for face recognition purposes.", "properties" : { "personSelectiveUpdate" : { "$ref" : "#/components/schemas/PersonSelectiveUpdate" } } }, "Facerecognition_person_UpdatePersonWSResponse" : { "type" : "object", "description" : "Response object for updating a person for face recognition purposes.", "properties" : { "person" : { "$ref" : "#/components/schemas/Person" } } }, "FeatureCompatabilityType" : { "type" : "object", "description" : "List of feature compatibility information", "properties" : { "betaRolloutOrgFlag" : { "type" : "string", "nullable" : true }, "betaRolloutOrgFlags" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "deviceFeatureEnablement" : { "$ref" : "#/components/schemas/DeviceFeatureEnum" }, "featureName" : { "type" : "string", "nullable" : true }, "generatedActivities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, "hardwareDefaultMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "requiredFirmwareVersion" : { "type" : "string", "nullable" : true }, "requiredLicenses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LicenseEnum" }, "nullable" : true }, "supportedHardware" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "nullable" : true } } }, "Feature_DeviceFeaturesType" : { "type" : "object", "description" : "Device features configuration with feature enablement mapping.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "featureMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "description" : "Map of device features to their enabled/disabled status", "nullable" : true }, "description" : "Map of device features to their enabled/disabled status", "nullable" : true } } }, "Feature_GetDeviceEventTypesWSRequest" : { "type" : "object", "description" : "Request object for retrieving possible event types for a device based on enabled features.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Feature_GetDeviceEventTypesWSResponse" : { "type" : "object", "description" : "Response object containing possible event types for a device based on enabled features.", "properties" : { "eventTypes" : { "type" : "array", "description" : "List of possible event types for the device", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true } } }, "Feature_GetDeviceFeaturesListWSRequest" : { "type" : "object", "description" : "Request object for retrieving enabled features for multiple devices in an organization.", "properties" : { "deviceUuids" : { "type" : "array", "description" : "List of device UUIDs to retrieve features for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true } } }, "Feature_GetDeviceFeaturesListWSResponse" : { "type" : "object", "description" : "Response object containing enabled features for multiple devices in an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "featureList" : { "type" : "array", "description" : "List of device features for each requested device", "items" : { "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Feature_GetDeviceFeaturesWSRequest" : { "type" : "object", "description" : "Request object for retrieving enabled features for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Feature_GetDeviceFeaturesWSResponse" : { "type" : "object", "description" : "Response object containing enabled features for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "features" : { "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Feature_GetFeatureCompatabilityMatrixWSRequest" : { "type" : "object", "description" : "Request object for retrieving the feature compatibility matrix." }, "Feature_GetFeatureCompatabilityMatrixWSResponse" : { "type" : "object", "description" : "Response object containing the feature compatibility matrix.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "featureCompatabilityMatrix" : { "type" : "array", "description" : "List of feature compatibility information", "items" : { "$ref" : "#/components/schemas/FeatureCompatabilityType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Feature_UpdateDeviceFeaturesWSRequest" : { "type" : "object", "description" : "Request object for updating enabled features for a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "featureMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "description" : "Map of device features to their new enabled/disabled status", "nullable" : true }, "description" : "Map of device features to their new enabled/disabled status", "nullable" : true } } }, "Feature_UpdateDeviceFeaturesWSResponse" : { "type" : "object", "description" : "Response object for updating enabled features for a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Fidoauth_DeleteCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { "credentialId" : { "type" : "string", "description" : "The id of the credential to be deleted", "nullable" : true } }, "required" : [ "credentialId" ] }, "Fidoauth_DeleteCredentialForCurrentUserWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, "credentials" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, "Fidoauth_FindCredentialsForCurrentUserWSRequest" : { "type" : "object", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, "Fidoauth_FindCredentialsForCurrentUserWSResponse" : { "type" : "object", "properties" : { "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true } } }, "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSRequest" : { "type" : "object", "properties" : { "reduceRequirementsForMultiFactorAuthOnlyCred" : { "type" : "boolean", "nullable" : true } } }, "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSResponse" : { "type" : "object", "properties" : { "registrationRequest" : { "$ref" : "#/components/schemas/JsonNode" } } }, "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSRequest" : { "type" : "object", "properties" : { "credentialId" : { "type" : "string", "description" : "The id of a mfa credential to attempt upgrading", "nullable" : true } }, "required" : [ "credentialId" ] }, "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSResponse" : { "type" : "object", "properties" : { "upgradeRequest" : { "$ref" : "#/components/schemas/JsonNode" } } }, "Fidoauth_RegisterCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { "registrationResponse" : { "$ref" : "#/components/schemas/JsonNode" } }, "required" : [ "registrationResponse" ] }, "Fidoauth_RegisterCredentialForCurrentUserWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, "Fidoauth_UpdateCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { "credentialId" : { "type" : "string", "description" : "The id of the credential to be updated", "nullable" : true }, "displayName" : { "type" : "string", "description" : "A new display name to apply to the credential", "nullable" : true } }, "required" : [ "credentialId" ] }, "Fidoauth_UpdateCredentialForCurrentUserWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, "credentials" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { "upgradeResponse" : { "$ref" : "#/components/schemas/JsonNode" } }, "required" : [ "upgradeResponse" ] }, "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSResponse" : { "type" : "object", "properties" : { "credential" : { "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, "FirmwareUpdateIntervalType" : { "type" : "object", "nullable" : true, "properties" : { "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfWeekStop" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "FirmwareUpdateModeEnum" : { "type" : "string", "enum" : [ "MANUAL", "SCHEDULED" ] }, "FirmwareUpdateSettingsOverrideType" : { "type" : "object", "description" : "Overrides default firmware update settings.", "nullable" : true, "properties" : { "deviceTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "firmwareUpdateSettings" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" } } }, "FirmwareUpdateSettingsType" : { "type" : "object", "nullable" : true, "properties" : { "intervalsV2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FirmwareUpdateIntervalType" }, "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/FirmwareUpdateModeEnum" } } }, "FirstInFirmwareStatusEnum" : { "type" : "string", "enum" : [ "DISABLED", "NOT_CONFIGURED", "REQUIRED", "SATISFIED", "UNKNOWN" ] }, "FirstInResetEnum" : { "type" : "string", "enum" : [ "DAILY" ] }, "FirstInShadow" : { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "source" : { "$ref" : "#/components/schemas/FirstInSourceEnum" }, "state" : { "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "FirstInSourceEnum" : { "type" : "string", "enum" : [ "CONFIG_MANUAL_OVERRIDE", "CONFIG_REQUIREMENT_CHANGE", "CONFIG_MEMBERSHIP", "SCHEDULED_RESET", "LOCAL_BADGE_EVENT", "LOCKDOWN", "UNKNOWN" ] }, "FirstInState" : { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, "FirstInState_Minimal" : { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" }, "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/FirstInStatusEnum_Minimal" } } }, "FirstInStatusEnum" : { "type" : "string", "enum" : [ "REQUIRED", "SATISFIED" ] }, "FirstInStatusEnum_Minimal" : { "type" : "string", "enum" : [ "REQUIRED", "SATISFIED" ] }, "FisheyeDisplayModeEnum" : { "type" : "string", "enum" : [ "RAW", "IMMERSIVE", "TILES", "RAW_PANO" ] }, "FixedPosition" : { "type" : "object", "properties" : { "left" : { "type" : "integer", "format" : "int32", "nullable" : true }, "page" : { "type" : "integer", "format" : "int32", "nullable" : true }, "place_key" : { "type" : "string", "nullable" : true }, "top" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "FlicDevice" : { "type" : "object", "properties" : { "flicAction" : { "type" : "string", "nullable" : true }, "flicBatteryLevel" : { "type" : "string", "nullable" : true }, "flicHub" : { "$ref" : "#/components/schemas/FlicHub" }, "flicName" : { "type" : "string", "nullable" : true }, "flicSerialNumber" : { "type" : "string", "nullable" : true }, "flicTimestamp" : { "type" : "integer", "format" : "int64", "nullable" : true }, "flicUuid" : { "type" : "string", "nullable" : true }, "lastClickedTimestamp" : { "type" : "string", "nullable" : true }, "moduleUuid" : { "type" : "string", "nullable" : true } } }, "FlicHub" : { "type" : "object", "properties" : { "flicHubName" : { "type" : "string", "nullable" : true }, "flicHubSerialNumber" : { "type" : "string", "nullable" : true }, "flicHubUuid" : { "type" : "string", "nullable" : true } } }, "FlicType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "apiSecret" : { "type" : "string", "nullable" : true }, "associatedLocations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "moduleUploaded" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "string", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "FloorPlanType" : { "type" : "object", "properties" : { "eastEdge" : { "type" : "number", "format" : "double", "nullable" : true }, "floorLabel" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "imageUrl" : { "type" : "string", "format" : "url", "nullable" : true }, "mediaUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "northEdge" : { "type" : "number", "format" : "double", "nullable" : true }, "rotation" : { "type" : "number", "format" : "double", "nullable" : true }, "southEdge" : { "type" : "number", "format" : "double", "nullable" : true }, "westEdge" : { "type" : "number", "format" : "double", "nullable" : true } } }, "FollowUpAction" : { "type" : "object", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/NotificationFollowUp" } ], "properties" : { "type" : { "$ref" : "#/components/schemas/ChatFollowUpActionEnum" } } }, "FootageBoundingBoxType" : { "type" : "object", "description" : "List of shared footage bounding boxes", "properties" : { "a" : { "$ref" : "#/components/schemas/ActivityEnum" }, "al" : { "type" : "boolean", "description" : "alerted on this?", "nullable" : true }, "b" : { "type" : "integer", "format" : "int32", "description" : "bounding box - bottom permyriad", "nullable" : true }, "c" : { "type" : "number", "format" : "float", "description" : "confidence", "nullable" : true }, "cd" : { "type" : "string", "description" : "Custom activity display description, maximum 100 characters", "nullable" : true }, "cdn" : { "type" : "string", "description" : "custom activity display name", "nullable" : true }, "croppedImageLocator" : { "type" : "string", "nullable" : true }, "customActivityColor" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "dw" : { "type" : "boolean", "description" : "bounding box is in a loiter state", "nullable" : true }, "fn" : { "type" : "string", "description" : "face names", "nullable" : true }, "kp" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PointType" }, "description" : "pose keypoints", "nullable" : true }, "l" : { "type" : "integer", "format" : "int32", "description" : "bounding box - left permyriad", "nullable" : true }, "loudness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lp" : { "type" : "string", "description" : "license plate", "nullable" : true }, "m" : { "type" : "boolean", "description" : "object in motion?", "nullable" : true }, "objectId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "p" : { "type" : "string", "description" : "pose", "nullable" : true }, "r" : { "type" : "integer", "format" : "int32", "description" : "bounding box - right permyriad", "nullable" : true }, "reid" : { "type" : "integer", "format" : "int32", "description" : "Stable track ID for re-identification across track segments", "nullable" : true }, "ro" : { "type" : "array", "description" : "recognized objects", "items" : { "type" : "string", "description" : "recognized objects", "nullable" : true }, "nullable" : true }, "sensorValType" : { "$ref" : "#/components/schemas/SensorValType" }, "t" : { "type" : "integer", "format" : "int32", "description" : "bounding box - top permyriad", "nullable" : true }, "toastOrderIdInfo" : { "$ref" : "#/components/schemas/ToastOrderIdType" }, "ts" : { "type" : "integer", "format" : "int64", "description" : "timestamp in milliseconds since epoch", "nullable" : true }, "uf" : { "type" : "string", "description" : "FaceId for an unidentified face", "nullable" : true }, "vn" : { "type" : "string", "description" : "vehicle name", "nullable" : true } }, "required" : [ "a", "b", "l", "r", "t", "ts" ] }, "FootageSeekPointColorEnum" : { "type" : "string", "enum" : [ "BLUE", "RED", "PURPLE", "TAN", "ORANGE", "TEAL", "GRAY", "BLACK" ] }, "FootageSeekPointType" : { "type" : "object", "description" : "List of shared footage seekpoints", "properties" : { "a" : { "$ref" : "#/components/schemas/ActivityEnum" }, "al" : { "type" : "boolean", "nullable" : true }, "b" : { "type" : "number", "format" : "float", "nullable" : true }, "fn" : { "type" : "string", "nullable" : true }, "kp" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PointType" }, "nullable" : true }, "l" : { "type" : "number", "format" : "float", "nullable" : true }, "lp" : { "type" : "string", "nullable" : true }, "p" : { "type" : "string", "nullable" : true }, "r" : { "type" : "number", "format" : "float", "nullable" : true }, "ro" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "t" : { "type" : "number", "format" : "float", "nullable" : true }, "ts" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uf" : { "type" : "string", "nullable" : true }, "vn" : { "type" : "string", "nullable" : true } } }, "FootageSeekPointV2Type" : { "type" : "object", "description" : "List of shared footage seekpoints (deprecated)", "properties" : { "a" : { "$ref" : "#/components/schemas/ActivityEnum" }, "ae" : { "type" : "string", "description" : "area being entered", "nullable" : true }, "al" : { "type" : "boolean", "description" : "alerted on this?", "nullable" : true }, "ax" : { "type" : "string", "description" : "area being exited", "nullable" : true }, "bs" : { "type" : "string", "description" : "badge status (e.g. Active, Lost)", "nullable" : true }, "bt" : { "type" : "string", "description" : "badge type", "nullable" : true }, "cc" : { "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, "cd" : { "type" : "string", "description" : "Custom activity display description, maximum 100 characters", "nullable" : true }, "cdn" : { "type" : "string", "description" : "Custom activity display name, maximum 32 characters", "nullable" : true }, "ch" : { "type" : "string", "description" : "badge holder's name", "nullable" : true }, "dcao" : { "type" : "boolean", "nullable" : true }, "dwelling" : { "type" : "boolean", "nullable" : true }, "em" : { "type" : "boolean", "description" : "access granted and entry made (false = no entry / possible tailgating)", "nullable" : true }, "fn" : { "type" : "string", "description" : "face names", "nullable" : true }, "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "loudness" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lp" : { "type" : "string", "description" : "license plate", "nullable" : true }, "m" : { "type" : "boolean", "description" : "object in motion?", "nullable" : true }, "p" : { "type" : "string", "description" : "pose", "nullable" : true }, "ro" : { "type" : "array", "description" : "recognized objects", "items" : { "type" : "string", "description" : "recognized objects", "nullable" : true }, "nullable" : true }, "sensorValType" : { "$ref" : "#/components/schemas/SensorValType" }, "stableTrackId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "toi" : { "$ref" : "#/components/schemas/ToastOrderIdType" }, "ts" : { "type" : "integer", "format" : "int64", "description" : "timestamp", "nullable" : true }, "tu" : { "type" : "string", "nullable" : true }, "uf" : { "type" : "string", "description" : "FaceId for an unidentified face", "nullable" : true }, "vn" : { "type" : "string", "description" : "vehicle name", "nullable" : true } }, "required" : [ "a", "ts" ] }, "FormDataBodyPart" : { "type" : "object", "nullable" : true, "properties" : { "content" : { "type" : "object", "nullable" : true }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "entity" : { "type" : "object", "nullable" : true }, "fileName" : { "type" : "string", "nullable" : true }, "formDataContentDisposition" : { "$ref" : "#/components/schemas/FormDataContentDisposition" }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "name" : { "type" : "string", "nullable" : true }, "parameterizedHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "providers" : { "$ref" : "#/components/schemas/Providers" }, "simple" : { "type" : "boolean", "nullable" : true }, "value" : { "type" : "string", "nullable" : true } } }, "FormDataContentDisposition" : { "type" : "object", "properties" : { "creationDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "fileName" : { "type" : "string", "nullable" : true }, "modificationDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "readDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "size" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "type" : "string", "nullable" : true } } }, "FormDataMultiPart" : { "type" : "object", "nullable" : true, "properties" : { "bodyParts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BodyPart" }, "nullable" : true }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "entity" : { "type" : "object", "nullable" : true }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FormDataBodyPart" }, "nullable" : true }, "nullable" : true }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "parameterizedHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "providers" : { "$ref" : "#/components/schemas/Providers" } } }, "FormaSensorType" : { "type" : "object", "properties" : { "ch2oPpb" : { "type" : "number", "format" : "float", "nullable" : true }, "relHumid" : { "type" : "number", "format" : "float", "nullable" : true }, "tempC" : { "type" : "number", "format" : "float", "nullable" : true }, "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Freight" : { "type" : "object", "properties" : { "warehouse" : { "$ref" : "#/components/schemas/WarehouseEnum" } } }, "FrequencyUnitEnum" : { "type" : "string", "enum" : [ "HOURS", "DAYS", "WEEKS", "MONTHS", "UNKNOWN" ] }, "FrontendEqualizerSettings" : { "type" : "object", "properties" : { "frequency" : { "type" : "integer", "format" : "int32", "nullable" : true }, "gain" : { "type" : "integer", "format" : "int32", "nullable" : true }, "q" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "FullDeviceStateType" : { "type" : "object", "description" : "Detailed state information for the specified NVR", "properties" : { "afSupport" : { "type" : "boolean", "nullable" : true }, "audioSupported" : { "type" : "boolean", "nullable" : true }, "baseVideoOperationUri" : { "type" : "string", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "connectionTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "latestFirmwareVersion" : { "type" : "string", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "maxZoomPercent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "onCameraState" : { "type" : "object", "additionalProperties" : { "type" : "object", "nullable" : true }, "nullable" : true }, "onCloudState" : { "type" : "object", "additionalProperties" : { "type" : "object", "nullable" : true }, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "stateUpdatedTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "versionsBehind" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "FunctionalityEnum" : { "type" : "string", "enum" : [ "DEVICE_ADMINISTRATION", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "FIRMWARE_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "CAMERA_ADMINISTRATION", "REGISTER_DEVICES", "DELETE_DEVICES", "LOCATION_ADMINISTRATION", "POLICY_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "MANAGE_FACES", "MANAGE_LICENSEPLATES", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "ALERT_MONITORING_ADMINISTRATION", "ALERT_MONITORING_VIEWONLY", "ALERT_MONITORING_OPERATOR", "GUEST_MANAGEMENT_ADMINISTRATION", "GUEST_MANAGEMENT_VIEWONLY", "CLIP_MANAGEMENT", "VIEW_SAVED_VIDEO", "VIEW_AND_MANAGE_SAVED_VIDEO", "CLLM_ADMINISTRATION", "UNKNOWN" ] }, "GeneaSettings" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true }, "webhookUuid" : { "type" : "string", "nullable" : true } } }, "GeneaType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true }, "webhookUuid" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GenericButtonShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "state" : { "$ref" : "#/components/schemas/GenericButtonStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "supervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "GenericButtonStateEnumType" : { "type" : "string", "enum" : [ "BUTTON_DOWN", "BUTTON_UP", "UNKNOWN" ] }, "GenericDoorType" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "GenericInputShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "state" : { "$ref" : "#/components/schemas/GenericInputStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "supervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "GenericInputStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newState" : { "$ref" : "#/components/schemas/GenericInputStateEnumType" }, "newSupervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GenericInputStateEnumType" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] }, "GenericObjectEmbedding" : { "type" : "object", "properties" : { "b" : { "type" : "integer", "format" : "int32", "description" : "bounding box - bottom permyriad", "nullable" : true }, "clipEndMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "embedding" : { "type" : "array", "items" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "embeddingId" : { "type" : "string", "nullable" : true }, "isMatch" : { "type" : "string", "description" : "Match confidence for the query: \"YES\", \"MAYBE\", or \"NO\". Set on CHARON model results; null for CLIP.", "nullable" : true }, "l" : { "type" : "integer", "format" : "int32", "description" : "bounding box - left permyriad", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "model" : { "$ref" : "#/components/schemas/ObjectSearchModelEnum" }, "objectId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "objectType" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "r" : { "type" : "integer", "format" : "int32", "description" : "bounding box - right permyriad", "nullable" : true }, "stableTrackId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "t" : { "type" : "integer", "format" : "int32", "description" : "bounding box - top permyriad", "nullable" : true }, "thumbnailLocation" : { "type" : "string", "nullable" : true }, "thumbnailUri" : { "type" : "string", "nullable" : true }, "timestamp" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "GenericObjectEmbeddingMatch" : { "type" : "object", "description" : "List of similar object embedding matches", "properties" : { "distance" : { "type" : "number", "format" : "float", "nullable" : true }, "embedding" : { "$ref" : "#/components/schemas/GenericObjectEmbedding" }, "matchedEmbeddingId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GenericPosSettings" : { "type" : "object", "description" : "Collection of service area settings for this restaurant", "nullable" : true, "properties" : { "assignedCameraList" : { "type" : "array", "description" : "A list of camera uuids from Rhombus that are assigned to the PoS device", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "posName" : { "type" : "string", "description" : "The name of the point of sale device", "nullable" : true } } }, "GenericPosType" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "GenericRelayShadowType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "state" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentShadowEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "GenericRelayStateChangeEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "steadyState" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" }, "steadyStateChangedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "transientState" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GenericRelayStateEnumType" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] }, "GenericRs485PhysicalPortEnum" : { "type" : "string", "enum" : [ "RS485" ] }, "GenericRs485Port" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/GenericRs485PhysicalPortEnum" } } }, "GenericVideoEmbedding" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "embedding" : { "type" : "array", "items" : { "type" : "number", "format" : "float", "nullable" : true }, "nullable" : true }, "embeddingId" : { "type" : "string", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "model" : { "$ref" : "#/components/schemas/VideoSimilarityModelEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "GenericVideoEmbeddingMatch" : { "type" : "object", "description" : "List of similar video embedding matches", "properties" : { "distance" : { "type" : "number", "format" : "float", "nullable" : true }, "embedding" : { "$ref" : "#/components/schemas/GenericVideoEmbedding" }, "matchedEmbeddingId" : { "type" : "string", "nullable" : true } } }, "GeoIpLocationType" : { "type" : "object", "properties" : { "city_name" : { "type" : "string", "nullable" : true }, "country_code" : { "type" : "string", "nullable" : true }, "country_name" : { "type" : "string", "nullable" : true }, "region_name" : { "type" : "string", "nullable" : true } } }, "GeodeticCoordinates" : { "type" : "object", "properties" : { "error" : { "$ref" : "#/components/schemas/GpsError" }, "floor" : { "type" : "integer", "format" : "int32", "nullable" : true }, "lat" : { "type" : "number", "format" : "double", "nullable" : true }, "lon" : { "type" : "number", "format" : "double", "nullable" : true } } }, "GetTemporaryOrgTokenResponse" : { "type" : "object", "properties" : { "tempOrgToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GoogleCaptchaSourceEnum" : { "type" : "string", "description" : "Source of the Google reCAPTCHA (legacy or V3)", "enum" : [ "LEGACY", "RHOMBUS_CONSOLE_WEB", "RHOMBUS_CONSOLE_ANDROID_APP", "RHOMBUS_CONSOLE_IOS_APP", "RHOMBUS_KEY_ANDROID_APP", "RHOMBUS_KEY_IOS_APP" ] }, "GoogleSettings" : { "type" : "object", "description" : "Google integration settings to update", "properties" : { "accountUser" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "folderId" : { "type" : "string", "nullable" : true }, "teamDriveId" : { "type" : "string", "nullable" : true } } }, "GoogleSettingsV2" : { "type" : "object", "properties" : { "defaultAlertFolderId" : { "type" : "string", "nullable" : true }, "defaultAlertFolderName" : { "type" : "string", "nullable" : true }, "defaultFolderId" : { "type" : "string", "nullable" : true }, "defaultFolderName" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "GoogleType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "allowUserStorage" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "defaultAlertFolderId" : { "type" : "string", "nullable" : true }, "defaultAlertFolderName" : { "type" : "string", "nullable" : true }, "defaultFolderId" : { "type" : "string", "nullable" : true }, "defaultFolderName" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/GoogleUserSettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GoogleUserSettings" : { "type" : "object", "nullable" : true, "properties" : { "defaultAlertFolderId" : { "type" : "string", "nullable" : true }, "defaultAlertFolderName" : { "type" : "string", "nullable" : true }, "defaultFolderId" : { "type" : "string", "nullable" : true }, "defaultFolderName" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } }, "GpsError" : { "type" : "object", "properties" : { "majorAxis" : { "type" : "number", "format" : "double", "nullable" : true }, "minorAxis" : { "type" : "number", "format" : "double", "nullable" : true }, "rotation" : { "type" : "number", "format" : "double", "nullable" : true } } }, "Group_AddUsersToOrgGroupWSRequest" : { "type" : "object", "description" : "Request to add users to an organization group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuids" : { "type" : "array", "description" : "List of user UUIDs to add to the group", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Group_AddUsersToOrgGroupWSResponse" : { "type" : "object", "description" : "Response for adding users to an organization group.", "properties" : { "groupMembers" : { "type" : "array", "description" : "Users added to the group successfully from the original request", "items" : { "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true } } }, "Group_CreateOrgGroupWSRequest" : { "type" : "object", "description" : "Request to create an organization group.", "properties" : { "description" : { "type" : "string", "description" : "Description of the group", "example" : "Software engineering team members", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the group", "example" : "Engineering Team", "nullable" : true }, "userUuids" : { "type" : "array", "description" : "List of user UUIDs to add to the group", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } }, "required" : [ "name" ] }, "Group_CreateOrgGroupWSResponse" : { "type" : "object", "description" : "Response for organization group creation.", "properties" : { "group" : { "$ref" : "#/components/schemas/OrgGroupType" }, "groupMembers" : { "type" : "array", "description" : "List of group members if optionally added when creating the group", "items" : { "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true } } }, "Group_DeleteOrgGroupWSRequest" : { "type" : "object", "description" : "Request to delete an organization group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Group_DeleteOrgGroupWSResponse" : { "type" : "object", "description" : "Response indicating successful deletion of an organization group." }, "Group_FindAllUsersForOrgGroupWSRequest" : { "type" : "object", "description" : "Request to find all users for an organization group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Group_FindAllUsersForOrgGroupWSResponse" : { "type" : "object", "description" : "Response containing all users for an organization group.", "properties" : { "groupMembers" : { "type" : "array", "description" : "List of group members", "items" : { "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true } } }, "Group_FindOrgGroupMembershipsByUserWSRequest" : { "type" : "object", "description" : "Request to find organization group memberships by user.", "properties" : { "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Group_FindOrgGroupMembershipsByUserWSResponse" : { "type" : "object", "description" : "Response containing organization group memberships for a user.", "properties" : { "userGroupMemberships" : { "type" : "array", "description" : "List of user group memberships", "items" : { "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true } } }, "Group_FindOrgGroupMembershipsForCurrentUserWSRequest" : { "type" : "object", "description" : "Request to find organization group memberships for current user." }, "Group_FindOrgGroupMembershipsForCurrentUserWSResponse" : { "type" : "object", "description" : "Response containing organization group memberships for current user.", "properties" : { "userGroupMemberships" : { "type" : "array", "description" : "List of current user group memberships", "items" : { "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true } } }, "Group_FindOrgGroupsByExactNameWSRequest" : { "type" : "object", "description" : "Request to find organization groups by exact name.", "properties" : { "groupName" : { "type" : "string", "description" : "Case insensitive name of the group to find, if it exists", "example" : "Engineering Team", "nullable" : true } } }, "Group_FindOrgGroupsByExactNameWSResponse" : { "type" : "object", "description" : "Response containing organization group found by exact name.", "properties" : { "group" : { "$ref" : "#/components/schemas/OrgGroupType" } } }, "Group_FindOrgGroupsByNamePrefixWSRequest" : { "type" : "object", "description" : "Request to find organization groups by name prefix.", "properties" : { "groupNamePrefix" : { "type" : "string", "description" : "Name prefix to search for groups", "example" : "Eng", "nullable" : true } } }, "Group_FindOrgGroupsByNamePrefixWSResponse" : { "type" : "object", "description" : "Response containing organization groups found by name prefix.", "properties" : { "groups" : { "type" : "array", "description" : "List of organization groups found by name prefix", "items" : { "$ref" : "#/components/schemas/OrgGroupType" }, "nullable" : true } } }, "Group_FindOrgGroupsByOrgWSRequest" : { "type" : "object", "description" : "Request to find organization groups by organization." }, "Group_FindOrgGroupsByOrgWSResponse" : { "type" : "object", "description" : "Response containing organization groups found by organization.", "properties" : { "groups" : { "type" : "array", "description" : "List of organization groups found by organization", "items" : { "$ref" : "#/components/schemas/OrgGroupType" }, "nullable" : true } } }, "Group_FindOrgGroupsByUserMembershipWSRequest" : { "type" : "object", "description" : "Request to find organization groups by user membership.", "properties" : { "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Group_FindOrgGroupsByUserMembershipWSResponse" : { "type" : "object", "description" : "Response containing organization groups found by user membership.", "properties" : { "groups" : { "type" : "array", "description" : "List of organization groups found by user membership", "items" : { "$ref" : "#/components/schemas/OrgGroupType" }, "nullable" : true } } }, "Group_RemoveUsersFromOrgGroupWSRequest" : { "type" : "object", "description" : "Request to remove users from an organization group.", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuids" : { "type" : "array", "description" : "List of user UUIDs to remove from the group", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Group_RemoveUsersFromOrgGroupWSResponse" : { "type" : "object", "description" : "Response indicating successful removal of users from an organization group." }, "Group_UpdateOrgGroupWSRequest" : { "type" : "object", "description" : "Request to update an organization group.", "properties" : { "description" : { "type" : "string", "description" : "New description for the group", "example" : "Updated software engineering team members", "nullable" : true }, "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "New name for the group", "example" : "Updated Engineering Team", "nullable" : true } } }, "Group_UpdateOrgGroupWSResponse" : { "type" : "object", "description" : "Response containing the updated organization group.", "properties" : { "group" : { "$ref" : "#/components/schemas/OrgGroupType" } } }, "Guest" : { "type" : "object", "description" : "Guest information to update", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "backgroundCheckStatus" : { "$ref" : "#/components/schemas/BackgroundCheckEnum" }, "checkedInEnum" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "city" : { "type" : "string", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "crime" : { "type" : "string", "nullable" : true }, "documentLastSignedMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "emailCaseSensitive" : { "type" : "string", "nullable" : true }, "faceImage" : { "type" : "string", "nullable" : true }, "firstName" : { "type" : "string", "nullable" : true }, "lastCheckedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastCheckedOutMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "profileImageKey" : { "type" : "string", "nullable" : true }, "profileImageUrl" : { "type" : "string", "nullable" : true }, "state" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/GuestStatusEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GuestActivityEnum" : { "type" : "string", "enum" : [ "CHECKED_IN", "CHECKED_OUT", "AUTO_CHECKED_OUT", "UPDATED_INFO", "INVITED", "SENT_DOCUMENTS_FOR_SIGNING", "SIGNED_DOCUMENTS", "UPDATED_INVITE", "RESENT_INVITE", "RESCINDED_INVITE" ] }, "GuestActivityLog" : { "type" : "object", "properties" : { "accessStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "activity" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "agent" : { "type" : "string", "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "detailsUpdated" : { "type" : "boolean", "nullable" : true }, "documentUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "email" : { "type" : "string", "nullable" : true }, "guestType" : { "$ref" : "#/components/schemas/GuestTypeEnum" }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rescinded" : { "type" : "boolean", "nullable" : true }, "signingEnvelopeId" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "walkIn" : { "type" : "boolean", "nullable" : true } } }, "GuestInvite" : { "type" : "object", "description" : "The invitation after the update, with every field and not only the ones the request changed. Absent only when the update failed, in which case error is set.", "properties" : { "accessEndTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "accessStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "checkedInEnum" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "checkedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "checkedOutMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "guestType" : { "$ref" : "#/components/schemas/GuestTypeEnum" }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastSentAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "meetingParticipants" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "rescindedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "rescindedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "signedDocuments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SignedDocument" }, "nullable" : true }, "signingEnvelopeId" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "walkIn" : { "type" : "boolean", "nullable" : true } } }, "GuestInviteAccessActionEnum" : { "type" : "string", "description" : "Discriminator for the access mode.", "enum" : [ "ADD_NEW", "ADD_REUSE", "EDIT", "REMOVE" ] }, "GuestInviteAccessUpdate" : { "type" : "object", "description" : "Polymorphic access change for a guest invite, discriminated on 'action'.", "discriminator" : { "propertyName" : "action" }, "oneOf" : [ { "$ref" : "#/components/schemas/AddNewPassAccessUpdate" }, { "$ref" : "#/components/schemas/AddReusePassAccessUpdate" }, { "$ref" : "#/components/schemas/EditPeriodAccessUpdate" }, { "$ref" : "#/components/schemas/RemoveAccessUpdate" } ], "properties" : { "action" : { "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" } }, "required" : [ "action" ] }, "GuestInviteSelectiveUpdateByInvocation" : { "type" : "object", "description" : "Guest invite to update", "properties" : { "accessEndTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "accessStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "checkedInEnum" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "checkedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "checkedOutMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "guestType" : { "$ref" : "#/components/schemas/GuestTypeEnum" }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastSentAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "meetingParticipants" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "rescindedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "rescindedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "signedDocuments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SignedDocument" }, "nullable" : true }, "signingEnvelopeId" : { "type" : "string", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "walkIn" : { "type" : "boolean", "nullable" : true } } }, "GuestManagementCatalogItem" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "GuestManagementDocument" : { "type" : "object", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultSigningCadence" : { "$ref" : "#/components/schemas/SigningCadence" }, "displayName" : { "type" : "string", "nullable" : true }, "docUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "fileName" : { "type" : "string", "nullable" : true }, "fixedPositions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FixedPosition" }, "nullable" : true }, "format" : { "type" : "string", "nullable" : true }, "lastUpdatedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUpdatedTimestampMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "mediaUrl" : { "type" : "string", "nullable" : true }, "places" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Place" }, "nullable" : true }, "signingCadenceOverrides" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SigningCadence" }, "nullable" : true } } }, "GuestManagementLicenseType" : { "type" : "object", "description" : "List of guest management licenses available for the client organization", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GuestManagementLocationSettings" : { "type" : "object", "properties" : { "assignableDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "assignableElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAssignedDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAssignedElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAutoAccessEndMinuteOfDay" : { "type" : "integer", "format" : "int32", "nullable" : true }, "defaultAutoAccessStartOffsetMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GuestManagementOrgSettings" : { "type" : "object", "properties" : { "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "documents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestManagementDocument" }, "nullable" : true }, "hexIdentityColor" : { "type" : "string", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "locationReceptionHostUserUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "logoImageString" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "userHostNotificationSettingsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true } } }, "GuestManagementSettingsSelectiveUpdate" : { "type" : "object", "properties" : { "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "documents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestManagementDocument" }, "nullable" : true }, "hexIdentityColor" : { "type" : "string", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "locationReceptionHostUserUuidMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "logoImageString" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "userHostNotificationSettingsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true } } }, "GuestManagementType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "locationSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/LocationSettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GuestPassEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "guestPassName" : { "type" : "string", "nullable" : true }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, "GuestPassIntervalSourceEnum" : { "type" : "string", "enum" : [ "ABSOLUTE", "DAILY", "AUTO" ] }, "GuestSelectiveUpdateByInvocation" : { "type" : "object", "description" : "The fields to change. The guest is identified by the update's uuid, or by its email when no uuid is given.", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "backgroundCheckStatus" : { "$ref" : "#/components/schemas/BackgroundCheckEnum" }, "checkedInEnum" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "city" : { "type" : "string", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "crime" : { "type" : "string", "nullable" : true }, "documentLastSignedMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "emailCaseSensitive" : { "type" : "string", "nullable" : true }, "faceImage" : { "type" : "string", "nullable" : true }, "firstName" : { "type" : "string", "nullable" : true }, "lastCheckedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastCheckedOutMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "profileImageKey" : { "type" : "string", "nullable" : true }, "profileImageUrl" : { "type" : "string", "nullable" : true }, "state" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/GuestStatusEnum" }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "GuestStatusEnum" : { "type" : "string", "enum" : [ "INVITED", "PENDING", "APPROVED", "DENIED" ] }, "GuestTypeEnum" : { "type" : "string", "enum" : [ "CONTRACTOR", "INTERVIEWER", "GENERAL_VISITOR", "UNPLANNED_VISITOR", "PARTNER", "MEETINGS" ] }, "Guestmanagement_ActivateKioskWSRequest" : { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_ActivateKioskWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "redirectUrl" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_BaseGuestManagementWSRequest" : { "type" : "object", "description" : "Base request object for guest management operations." }, "Guestmanagement_CreateEnvelopeWSRequest" : { "type" : "object", "properties" : { "docUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "signerEmail" : { "type" : "string", "nullable" : true }, "signerName" : { "type" : "string", "nullable" : true }, "title" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_CreateEnvelopeWSResponse" : { "type" : "object", "properties" : { "ceremonyUrl" : { "type" : "string", "nullable" : true }, "envelopeId" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_CreateGuestInviteWSRequest" : { "type" : "object", "description" : "Request object for creating a visit for an existing guest.", "properties" : { "access" : { "$ref" : "#/components/schemas/GuestInviteAccessUpdate" }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "guestInvite", "guestUuid" ] }, "Guestmanagement_CreateGuestInviteWSResponse" : { "type" : "object", "description" : "Response object describing the visit that was created, and any access provisioned for it. No email is sent, so there is nothing here about one.", "properties" : { "accessPeriodUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_CreateGuestManagementSettingsWSRequest" : { "type" : "object", "properties" : { "settings" : { "$ref" : "#/components/schemas/GuestManagementOrgSettings" } } }, "Guestmanagement_CreateGuestManagementSettingsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_CreateGuestV2WSRequest" : { "type" : "object", "description" : "Request object for creating a guest. Identity only - no visit is created.", "properties" : { "guest" : { "$ref" : "#/components/schemas/Guest" } }, "required" : [ "guest" ] }, "Guestmanagement_CreateGuestV2WSResponse" : { "type" : "object", "description" : "Response object describing the guest that was created.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_CreateGuestWSRequest" : { "type" : "object", "description" : "Request object for creating a guest with optional file attachment.", "properties" : { "fileName" : { "type" : "string", "description" : "Optional file name for guest attachment", "example" : "guest_photo.jpg", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" } } }, "Guestmanagement_DeleteGuestWSRequest" : { "type" : "object", "description" : "Request object for deleting a guest, named by uuid or by email.", "properties" : { "email" : { "type" : "string", "description" : "Email of the guest to delete. Used only when no uuid is given.", "nullable" : true }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_ExportGuestActivitiesWSRequest" : { "type" : "object", "properties" : { "beginTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "includeGuestTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "includeLocations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Guestmanagement_ExportGuestsWSRequest" : { "type" : "object", "properties" : { "beginTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "includeGuestTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "includeLocations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Guestmanagement_GetActivityLogsForGuestWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_GetActivityLogsForLocationWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dynamoPageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_GetAllGuestInvitesWSResponse" : { "type" : "object", "description" : "Response object containing all guest invites.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestInvites" : { "type" : "array", "description" : "List of all guest invites", "items" : { "$ref" : "#/components/schemas/GuestInvite" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetAllGuestsWSResponse" : { "type" : "object", "description" : "Response object containing all guests.", "properties" : { "allGuests" : { "type" : "array", "description" : "List of all guests", "items" : { "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetDocumentsToSignV2WSRequest" : { "type" : "object", "description" : "Request object for listing the documents a guest is due to sign for a visit.", "properties" : { "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timeZone" : { "type" : "string", "description" : "Timezone the day is resolved in when no inviteUuid is given. Defaults to the guest's location.", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "The moment the visit is being assessed at. Defaults to now.", "nullable" : true } }, "required" : [ "guestUuid" ] }, "Guestmanagement_GetDocumentsToSignWSRequest" : { "type" : "object", "description" : "Request object for the documents a guest has left to sign on a given visit.", "properties" : { "email" : { "type" : "string", "description" : "Email address of the guest", "example" : "guest@example.com", "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timeZone" : { "type" : "string", "description" : "IANA zone id of the requesting device", "example" : "America/Los_Angeles", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch millis the request is being made for; defaults to now", "nullable" : true } } }, "Guestmanagement_GetDocumentsToSignWSResponse" : { "type" : "object", "properties" : { "documents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestManagementDocument" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetEnvelopeWSRequest" : { "type" : "object", "properties" : { "envelopeId" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetEnvelopeWSResponse" : { "type" : "object", "properties" : { "ceremonyUrl" : { "type" : "string", "nullable" : true }, "envelopeId" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestActivityLogsWSRequest" : { "type" : "object", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dynamoPageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" } } }, "Guestmanagement_GetGuestActivityLogsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestActivities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestActivityLog" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestInviteForDayWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Guestmanagement_GetGuestInviteWSResponse" : { "type" : "object", "description" : "Response object containing guest invite information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestInvitesWSResponse" : { "type" : "object", "description" : "Response object containing guest invites.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestInvites" : { "type" : "array", "description" : "List of guest invites", "items" : { "$ref" : "#/components/schemas/GuestInvite" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestManagementLocationSettingsForOrgWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GuestManagementLocationSettings" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestManagementLocationSettingsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "$ref" : "#/components/schemas/GuestManagementLocationSettings" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestManagementSettingsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "$ref" : "#/components/schemas/GuestManagementOrgSettings" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestPassesForOrgWSRequest" : { "type" : "object", "description" : "Request object for listing the org's guest-management guest passes.", "properties" : { "paginateRequest" : { "$ref" : "#/components/schemas/PaginateRequest" }, "startAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Only return passes starting at or after this time.", "nullable" : true }, "startBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Only return passes starting at or before this time.", "nullable" : true } } }, "Guestmanagement_GetGuestPassesWSResponse" : { "type" : "object", "description" : "Response object containing guest-management guest passes.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestPasses" : { "type" : "array", "description" : "The org's guest passes whose principal is a guest-management guest. Passes created outside guest management are deliberately not returned.", "items" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Cursor to pass back as paginateRequest.lastEvaluatedKey for the next page. Absent on the last page.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetGuestWSResponse" : { "type" : "object", "description" : "Response object containing guest information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "guestPasses" : { "type" : "array", "description" : "The guest's live guest passes - lifecycle ACTIVE or SUSPENDED. Expired and archived passes are deliberately omitted. A guest can have more than one.", "items" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetInvitesForOrgWSRequest" : { "type" : "object", "properties" : { "invitedAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "invitedBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "paginateRequest" : { "$ref" : "#/components/schemas/PaginateRequest" } } }, "Guestmanagement_GetKioskInfoWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "kiosk" : { "$ref" : "#/components/schemas/Kiosk" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetKiosksForOrgWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "kiosks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Kiosk" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetNametagTemplateForGuestWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "timeZone" : { "type" : "string", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Guestmanagement_GetNametagTemplateForGuestWSResponse" : { "type" : "object", "properties" : { "badgeTemplate" : { "$ref" : "#/components/schemas/BadgeTemplate" }, "companyLogoUrl" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GetSignedDocumentsWSResponse" : { "type" : "object", "properties" : { "documents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Guestmanagement_SignedDocumentWSType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_GuestByEmailWSRequest" : { "type" : "object", "description" : "Request object for finding a guest by email address.", "properties" : { "email" : { "type" : "string", "description" : "Email address of the guest to find", "example" : "guest@example.com", "nullable" : true } } }, "Guestmanagement_GuestByUuidWSRequest" : { "type" : "object", "description" : "Request object for finding a guest by uuid.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Guestmanagement_GuestCheckinV2WSRequest" : { "type" : "object", "description" : "Request object for checking a guest into a visit that already exists.", "properties" : { "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "guestUuid", "locationUuid" ] }, "Guestmanagement_GuestCheckinWSRequest" : { "type" : "object", "description" : "Request object for guest check-in operations.", "properties" : { "email" : { "type" : "string", "description" : "Email address of the guest checking in", "example" : "guest@example.com", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "email", "locationUuid" ] }, "Guestmanagement_GuestInviteWSRequest" : { "type" : "object", "description" : "Request object for guest invite operations.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "uuid" ] }, "Guestmanagement_GuestInvitesByEmailWSRequest" : { "type" : "object", "description" : "Request object for finding guest invites by email address.", "properties" : { "email" : { "type" : "string", "description" : "Email of the guest to invite", "example" : "guest@example.com", "nullable" : true } }, "required" : [ "email" ] }, "Guestmanagement_GuestInvitesByGuestUuidWSRequest" : { "type" : "object", "description" : "Request object for listing a guest's visits.", "properties" : { "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "guestUuid" ] }, "Guestmanagement_GuestManagementLocationSettingsWSRequest" : { "type" : "object", "description" : "Addresses the guest-management settings of a single location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_GuestWSRequest" : { "type" : "object", "description" : "Request object containing guest information.", "properties" : { "guest" : { "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" } } }, "Guestmanagement_InviteGuestWSRequest" : { "type" : "object", "description" : "Request object for inviting a guest.", "properties" : { "access" : { "$ref" : "#/components/schemas/GuestInviteAccessUpdate" }, "guest" : { "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" } } }, "Guestmanagement_InviteGuestWSResponse" : { "type" : "object", "description" : "Response object describing the invitation that was sent, and the guest-pass access provisioned for it.", "properties" : { "accessPeriodUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_SignedDocumentWSType" : { "type" : "object", "properties" : { "deliverableId" : { "type" : "string", "nullable" : true }, "downloadUrl" : { "type" : "string", "nullable" : true }, "generatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_UpdateGuestInviteWSRequest" : { "type" : "object", "description" : "Request object for updating guest invite information.", "properties" : { "accessUpdate" : { "$ref" : "#/components/schemas/GuestInviteAccessUpdate" }, "inviteUpdate" : { "$ref" : "#/components/schemas/GuestInviteSelectiveUpdateByInvocation" }, "suppressGuestEmail" : { "type" : "boolean", "default" : false, "description" : "Set to keep this edit off the guest's inbox even when it changes something they were told. For corrections the sender is following up on themselves.", "nullable" : true } }, "required" : [ "inviteUpdate" ] }, "Guestmanagement_UpdateGuestInviteWSResponse" : { "type" : "object", "description" : "Response object describing the invitation as it now stands, the access it carries, and whether the guest was told about the change.", "properties" : { "accessPeriodUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestEmailSent" : { "type" : "boolean", "description" : "Whether a revised invitation reached the guest. False when the edit changed nothing they were told, when the request suppressed the email, or when the invite is rescinded.", "nullable" : true }, "guestInvite" : { "$ref" : "#/components/schemas/GuestInvite" }, "guestPass" : { "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_UpdateGuestManagementDocumentWSRequest" : { "type" : "object", "properties" : { "docUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "document" : { "$ref" : "#/components/schemas/GuestManagementDocument" } } }, "Guestmanagement_UpdateGuestManagementDocumentWSResponse" : { "type" : "object", "properties" : { "document" : { "$ref" : "#/components/schemas/GuestManagementDocument" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_UpdateGuestManagementLocationSettingsWSRequest" : { "type" : "object", "description" : "Upserts one location's guest-management settings. Send each set in full; null leaves a set unchanged and empty clears it.", "properties" : { "assignableDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "assignableElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAssignedDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAssignedElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "defaultAutoAccessEndMinuteOfDay" : { "type" : "integer", "format" : "int32", "nullable" : true }, "defaultAutoAccessStartOffsetMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Guestmanagement_UpdateGuestManagementLocationSettingsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "$ref" : "#/components/schemas/GuestManagementLocationSettings" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_UpdateGuestManagementSettingsWSRequest" : { "type" : "object", "properties" : { "settingsUpdate" : { "$ref" : "#/components/schemas/GuestManagementSettingsSelectiveUpdate" } } }, "Guestmanagement_UpdateGuestManagementSettingsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Guestmanagement_UpdateGuestV2WSRequest" : { "type" : "object", "description" : "Request object for updating a guest. Identity only - no visit is created or edited.", "properties" : { "guestUpdate" : { "$ref" : "#/components/schemas/GuestSelectiveUpdateByInvocation" } }, "required" : [ "guestUpdate" ] }, "Guestmanagement_UpdateGuestWSRequest" : { "type" : "object", "description" : "Request object for updating guest information.", "properties" : { "fileName" : { "type" : "string", "description" : "File name for guest-related data", "example" : "guest_data.csv", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "guestUpdate" : { "$ref" : "#/components/schemas/GuestSelectiveUpdateByInvocation" } } }, "Guestmanagement_legacykiosk_LegacyKioskGuest" : { "type" : "object", "description" : "Who is visiting - name, email, phone, and the rest of their identity.", "properties" : { "accessEndTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "accessStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "backgroundCheckStatus" : { "$ref" : "#/components/schemas/BackgroundCheckEnum" }, "checkedInEnum" : { "$ref" : "#/components/schemas/GuestActivityEnum" }, "city" : { "type" : "string", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "crime" : { "type" : "string", "nullable" : true }, "documentLastSignedMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "emailCaseSensitive" : { "type" : "string", "nullable" : true }, "faceImage" : { "type" : "string", "nullable" : true }, "firstName" : { "type" : "string", "nullable" : true }, "guestType" : { "type" : "string", "nullable" : true }, "hostUserUuid" : { "type" : "string", "nullable" : true }, "lastCheckedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastCheckedOutMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "meetingParticipants" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "phoneNumber" : { "type" : "string", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "profileImageUrl" : { "type" : "string", "nullable" : true }, "state" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/GuestStatusEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "HaloSettings" : { "type" : "object", "properties" : { "alertAgression" : { "type" : "boolean", "nullable" : true }, "alertCO" : { "type" : "boolean", "nullable" : true }, "alertCO2" : { "type" : "boolean", "nullable" : true }, "alertGunshot" : { "type" : "boolean", "nullable" : true }, "alertHelp" : { "type" : "boolean", "nullable" : true }, "alertMasking" : { "type" : "boolean", "nullable" : true }, "alertTHC" : { "type" : "boolean", "nullable" : true }, "alertTamper" : { "type" : "boolean", "nullable" : true }, "alertTemp" : { "type" : "boolean", "nullable" : true }, "alertVOC" : { "type" : "boolean", "nullable" : true }, "alertVape" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "savedClipDurationMs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "sensorName" : { "type" : "string", "nullable" : true }, "sensorToCamerasMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "url" : { "type" : "string", "nullable" : true } } }, "HardwareInvoiceSubItem" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "price" : { "type" : "number", "format" : "float", "nullable" : true } } }, "HardwareType" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "enforcedMinFirmwareVersion" : { "type" : "string", "nullable" : true }, "firmwareUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "hwSupportDomain" : { "type" : "string", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "mac" : { "type" : "string", "nullable" : true }, "manufacturedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "otaDisabled" : { "type" : "boolean", "nullable" : true }, "pendingRegistrationDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pendingRegistrationOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pendingRegistrationToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sdSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "HardwareVariationEnum" : { "type" : "string", "enum" : [ "RASPBERRY_PI_3", "CAMERA_R1", "CAMERA_R2", "CAMERA_R2_LONG_RANGE", "CAMERA_R2_180", "CAMERA_R3", "CAMERA_R4", "CAMERA_R100", "CAMERA_R120", "CAMERA_R170", "CAMERA_R200", "CAMERA_R500", "CAMERA_R510", "CAMERA_R520", "CAMERA_R600", "SENSOR_ASSET_TAG_T1", "SENSOR_DOOR_D1", "SENSOR_DOOR_D20", "SENSOR_ENVIRONMENTAL_E1", "SENSOR_ENVIRONMENTAL_E15", "SENSOR_ENVIRONMENTAL_E2", "SENSOR_MOTION_M1", "SENSOR_MOTION_M15", "GATEWAY_A1", "GATEWAY_A100", "GATEWAY_ENVIRONMENTAL_E50", "CAMERA_R220", "CAMERA_R230", "CAMERA_R36S", "CAMERA_R410", "CAMERA_R540", "CAMERA_R545", "BADGE_READER_DR1", "BADGE_READER_DR40", "BADGE_READER_DR20", "DOOR_CONTROLLER_DC1", "DOOR_CONTROLLER_DC20", "DOOR_CONTROLLER_DC10", "ETHERNET_TESTER_ET1", "IO_BOARD_TB1", "BLE_BUTTON_B10", "BLE_BUTTON_B15", "CAMERA_THIRD_PARTY_RELAY", "CAMERA_THIRD_PARTY_NVR", "CAMERA_THIRD_PARTY_NVR_MULTISENSOR", "NVR_N100", "CAMERA_R130", "NVR_N500", "CAMERA_R150", "ROBOT_RC1", "CAMERA_R210", "CAMERA_R650", "NVR_N550", "NVR_N551", "UNSPECIFIED" ] }, "HealthNotificationConditionTypeEnum" : { "type" : "string", "enum" : [ "DEVICE_OFFLINE", "CLOUD_ARCHIVE_LAG", "LOCAL_RECORDING_FAILURE" ] }, "HealthNotificationRuleType" : { "type" : "object", "description" : "List of health notification rules", "properties" : { "conditionType" : { "$ref" : "#/components/schemas/HealthNotificationConditionTypeEnum" }, "deviceCountThreshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, "durationMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "notifyOnRecovery" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reAlertAfterMinutes" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scope" : { "$ref" : "#/components/schemas/DeviceTargetScopeEnum" }, "targetUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "HeatIndexRangeWarningEnum" : { "type" : "string", "description" : "Heat index range warning status", "enum" : [ "HEAT_INDEX_OK", "HEAT_INDEX_WARNING", "HEAT_INDEX_UNSUPPORTED" ] }, "Help_CreateTicketWSRequest" : { "type" : "object", "description" : "Request object for creating a support ticket.", "properties" : { "body" : { "type" : "string", "description" : "Body content of the support ticket", "example" : "My camera is not connecting to the network properly.", "nullable" : true }, "collaborators" : { "type" : "array", "description" : "List of collaborator email addresses", "items" : { "type" : "string", "description" : "List of collaborator email addresses", "nullable" : true }, "nullable" : true }, "consoleAccessGranted" : { "type" : "boolean", "description" : "Whether console access has been granted for troubleshooting", "example" : true, "nullable" : true }, "productType" : { "type" : "string", "nullable" : true }, "serialNumbers" : { "type" : "array", "description" : "List of device serial numbers related to the issue", "items" : { "type" : "string", "description" : "List of device serial numbers related to the issue", "nullable" : true }, "nullable" : true }, "serviceType" : { "type" : "string", "nullable" : true }, "subject" : { "type" : "string", "description" : "Subject of the support ticket", "example" : "Camera connectivity issue", "nullable" : true } } }, "Help_CreateTicketWSResponse" : { "type" : "object", "description" : "Response object for creating a support ticket.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failureReason" : { "type" : "string", "description" : "Reason for failure if ticket creation was unsuccessful", "example" : "Invalid email address", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Whether the ticket creation was successful", "example" : true, "nullable" : true }, "ticketId" : { "type" : "integer", "format" : "int32", "description" : "ID of the created support ticket", "example" : 12345, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Help_GetOpenTicketsV2WSRequest" : { "type" : "object", "description" : "Request object for retrieving open support tickets V2 with time range filtering.", "properties" : { "endTimeMs" : { "type" : "integer", "format" : "int64", "description" : "End time in milliseconds for filtering tickets", "example" : 1642319999999, "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "description" : "Start time in milliseconds for filtering tickets", "example" : 1642233600000, "nullable" : true } } }, "Help_GetOpenTicketsV2WSResponse" : { "type" : "object", "description" : "Response object containing open support tickets V2 with organization and user tickets.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "tickets" : { "type" : "array", "description" : "List of organization support tickets", "items" : { "$ref" : "#/components/schemas/Help_TicketInformation" }, "nullable" : true }, "userTickets" : { "type" : "array", "description" : "List of user-specific support tickets", "items" : { "$ref" : "#/components/schemas/Help_TicketInformation" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Help_GetOpenTicketsWSRequest" : { "type" : "object", "description" : "Request object for retrieving open support tickets with pagination.", "properties" : { "pageNumber" : { "type" : "integer", "format" : "int32", "description" : "Page number used for paginated response. If empty, the search will return the first page.", "nullable" : true } } }, "Help_GetOpenTicketsWSResponse" : { "type" : "object", "description" : "Response object containing open support tickets with pagination information.", "properties" : { "currentPage" : { "type" : "integer", "format" : "int32", "description" : "Current page number in the paginated response", "example" : 1, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "hasNexPage" : { "type" : "boolean", "description" : "True if there is a next page, false otherwise", "nullable" : true }, "tickets" : { "type" : "array", "description" : "List of open support tickets", "items" : { "$ref" : "#/components/schemas/Help_TicketInformation" }, "nullable" : true }, "totalTickets" : { "type" : "integer", "format" : "int32", "description" : "Total number of tickets, not limited to the current page", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Help_ProcessRMAWSRequest" : { "type" : "object", "description" : "Request object for processing a Return Merchandise Authorization (RMA).", "properties" : { "contactName" : { "type" : "string", "description" : "Contact name for the RMA", "example" : "John Doe", "nullable" : true }, "contactPhoneNumber" : { "type" : "string", "description" : "Contact phone number for the RMA", "example" : "+1-555-123-4567", "nullable" : true }, "deviceName" : { "type" : "string", "description" : "Name of the device for RMA", "example" : "Rhombus Camera Pro", "nullable" : true }, "problem" : { "type" : "string", "description" : "Description of the problem with the device", "example" : "Camera not recording properly", "nullable" : true }, "returnShippingAddress" : { "$ref" : "#/components/schemas/Help_ShippingAddress" }, "serialNumber" : { "type" : "string", "description" : "Serial number of the device", "example" : "RHCAM123456789", "nullable" : true } } }, "Help_ProcessRMAWSResponse" : { "type" : "object", "description" : "Response object for processing a Return Merchandise Authorization (RMA).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failureReason" : { "type" : "string", "description" : "Reason for failure if RMA processing was unsuccessful", "example" : "Invalid serial number", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Whether the RMA processing was successful", "example" : true, "nullable" : true }, "ticketId" : { "type" : "integer", "format" : "int32", "description" : "ID of the RMA ticket created", "example" : 12345, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Help_SendFeedbackWSRequest" : { "type" : "object", "description" : "Request object for sending system feedback.", "properties" : { "feedback" : { "type" : "string", "description" : "Feedback message about the system", "example" : "The new interface is much more user-friendly!", "nullable" : true } } }, "Help_SendFeedbackWSResponse" : { "type" : "object", "description" : "Response object for sending system feedback.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failureReason" : { "type" : "string", "description" : "Reason for failure if feedback sending was unsuccessful", "example" : "Invalid feedback content", "nullable" : true }, "success" : { "type" : "boolean", "description" : "Whether the feedback was sent successfully", "example" : true, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Help_ShippingAddress" : { "type" : "object", "description" : "Shipping address information for RMA returns.", "properties" : { "returnAddressCity" : { "type" : "string", "description" : "City for return shipping", "example" : "San Francisco", "nullable" : true }, "returnAddressCountry" : { "type" : "string", "description" : "Country for return shipping", "example" : "United States", "nullable" : true }, "returnAddressPostalCode" : { "type" : "string", "description" : "Postal code for return shipping", "example" : "94105", "nullable" : true }, "returnAddressState" : { "type" : "string", "description" : "State/province for return shipping", "example" : "CA", "nullable" : true }, "returnAddressStreet" : { "type" : "string", "description" : "Street address for return shipping", "example" : "123 Main Street", "nullable" : true } } }, "Help_TicketInformation" : { "type" : "object", "description" : "Information about a support ticket.", "properties" : { "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Date when the ticket was created", "example" : "2024-01-15T10:30:00Z", "nullable" : true }, "id" : { "type" : "integer", "format" : "int32", "description" : "Unique identifier for the support ticket", "example" : 12345, "nullable" : true }, "status" : { "type" : "string", "description" : "Current status of the support ticket", "example" : "Open", "nullable" : true }, "subject" : { "type" : "string", "description" : "Subject of the support ticket", "example" : "Camera connectivity issue", "nullable" : true } } }, "Help_TriageDeviceWSRequest" : { "type" : "object", "description" : "Request object for triaging device connection/recording issues.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "startDateSec" : { "type" : "integer", "format" : "int64", "description" : "Start date in seconds for triage analysis", "example" : 1642233600, "nullable" : true } } }, "Help_TriageDeviceWSResponse" : { "type" : "object", "description" : "Response object containing device triage diagnostic information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "firmwareUpdates" : { "type" : "array", "description" : "List of firmware update diagnostic events", "items" : { "$ref" : "#/components/schemas/DiagnosticEventType" }, "nullable" : true }, "hardwareFailureEvents" : { "type" : "array", "description" : "List of hardware failure diagnostic events", "items" : { "$ref" : "#/components/schemas/DiagnosticEventType" }, "nullable" : true }, "message" : { "type" : "string", "description" : "Triage analysis message", "example" : "Device appears to be functioning normally", "nullable" : true }, "presenceWindows" : { "type" : "array", "description" : "List of device presence time windows", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "suggestedArticles" : { "type" : "array", "description" : "List of suggested help articles for the device issue", "items" : { "type" : "string", "description" : "List of suggested help articles for the device issue", "nullable" : true }, "nullable" : true }, "uptimeWindows" : { "type" : "array", "description" : "List of device uptime time windows", "items" : { "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "HoneywellElementsType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiKey" : { "type" : "string", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "baseUrl" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "siteId" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "HoneywellNetBoxType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "baseUrl" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "HoneywellOnGuardType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deploymentToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OnGuardDeploymentSettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "HttpHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "accept" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaType" }, "nullable" : true }, "acceptCharset" : { "type" : "array", "items" : { "type" : "object", "nullable" : true, "properties" : { "registered" : { "type" : "boolean", "nullable" : true } } }, "nullable" : true }, "acceptLanguage" : { "type" : "array", "items" : { "type" : "object", "nullable" : true, "properties" : { "range" : { "type" : "string", "nullable" : true }, "weight" : { "type" : "number", "format" : "double", "nullable" : true } } }, "nullable" : true }, "acceptLanguageAsLocales" : { "type" : "array", "items" : { "type" : "object", "nullable" : true, "properties" : { "country" : { "type" : "string", "nullable" : true }, "displayCountry" : { "type" : "string", "nullable" : true }, "displayLanguage" : { "type" : "string", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "displayScript" : { "type" : "string", "nullable" : true }, "displayVariant" : { "type" : "string", "nullable" : true }, "extensionKeys" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "iso3Country" : { "type" : "string", "nullable" : true }, "iso3Language" : { "type" : "string", "nullable" : true }, "language" : { "type" : "string", "nullable" : true }, "script" : { "type" : "string", "nullable" : true }, "unicodeLocaleAttributes" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unicodeLocaleKeys" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "variant" : { "type" : "string", "nullable" : true } } }, "nullable" : true }, "acceptPatch" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaType" }, "nullable" : true }, "accessControlAllowCredentials" : { "type" : "boolean", "nullable" : true }, "accessControlAllowHeaders" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "accessControlAllowMethods" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HttpMethod" }, "nullable" : true }, "accessControlAllowOrigin" : { "type" : "string", "nullable" : true }, "accessControlExposeHeaders" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "accessControlMaxAge" : { "type" : "integer", "format" : "int64", "nullable" : true }, "accessControlRequestHeaders" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "accessControlRequestMethod" : { "$ref" : "#/components/schemas/HttpMethod" }, "all" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true, "writeOnly" : true }, "allow" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HttpMethod" }, "nullable" : true, "uniqueItems" : true }, "basicAuth" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "bearerAuth" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "cacheControl" : { "type" : "string", "nullable" : true }, "connection" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "contentLanguage" : { "type" : "object", "nullable" : true, "properties" : { "country" : { "type" : "string", "nullable" : true }, "displayCountry" : { "type" : "string", "nullable" : true }, "displayLanguage" : { "type" : "string", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "displayScript" : { "type" : "string", "nullable" : true }, "displayVariant" : { "type" : "string", "nullable" : true }, "extensionKeys" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "iso3Country" : { "type" : "string", "nullable" : true }, "iso3Language" : { "type" : "string", "nullable" : true }, "language" : { "type" : "string", "nullable" : true }, "script" : { "type" : "string", "nullable" : true }, "unicodeLocaleAttributes" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "unicodeLocaleKeys" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "variant" : { "type" : "string", "nullable" : true } } }, "contentLength" : { "type" : "integer", "format" : "int64", "nullable" : true }, "contentType" : { "$ref" : "#/components/schemas/MediaType" }, "date" : { "type" : "integer", "format" : "int64", "nullable" : true }, "empty" : { "type" : "boolean", "nullable" : true }, "etag" : { "type" : "string", "nullable" : true }, "expires" : { "type" : "integer", "format" : "int64", "nullable" : true }, "host" : { "type" : "object", "nullable" : true, "properties" : { "address" : { "type" : "object", "nullable" : true, "properties" : { "address" : { "type" : "array", "items" : { "type" : "string", "format" : "byte", "nullable" : true }, "nullable" : true }, "anyLocalAddress" : { "type" : "boolean", "nullable" : true }, "canonicalHostName" : { "type" : "string", "nullable" : true }, "hostAddress" : { "type" : "string", "nullable" : true }, "hostName" : { "type" : "string", "nullable" : true }, "linkLocalAddress" : { "type" : "boolean", "nullable" : true }, "loopbackAddress" : { "type" : "boolean", "nullable" : true }, "mcglobal" : { "type" : "boolean", "nullable" : true }, "mclinkLocal" : { "type" : "boolean", "nullable" : true }, "mcnodeLocal" : { "type" : "boolean", "nullable" : true }, "mcorgLocal" : { "type" : "boolean", "nullable" : true }, "mcsiteLocal" : { "type" : "boolean", "nullable" : true }, "multicastAddress" : { "type" : "boolean", "nullable" : true }, "siteLocalAddress" : { "type" : "boolean", "nullable" : true } } }, "hostName" : { "type" : "string", "nullable" : true }, "hostString" : { "type" : "string", "nullable" : true }, "port" : { "type" : "integer", "format" : "int32", "nullable" : true }, "unresolved" : { "type" : "boolean", "nullable" : true } } }, "ifMatch" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "ifModifiedSince" : { "type" : "integer", "format" : "int64", "nullable" : true }, "ifNoneMatch" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "ifUnmodifiedSince" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "location" : { "type" : "string", "format" : "uri", "nullable" : true }, "origin" : { "type" : "string", "nullable" : true }, "pragma" : { "type" : "string", "nullable" : true }, "range" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HttpRange" }, "nullable" : true }, "upgrade" : { "type" : "string", "nullable" : true }, "vary" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "HttpMethod" : { "type" : "object" }, "HttpRange" : { "type" : "object" }, "HttpStatusCode" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "is1xxInformational" : { "type" : "boolean", "nullable" : true }, "is2xxSuccessful" : { "type" : "boolean", "nullable" : true }, "is3xxRedirection" : { "type" : "boolean", "nullable" : true }, "is4xxClientError" : { "type" : "boolean", "nullable" : true }, "is5xxServerError" : { "type" : "boolean", "nullable" : true } } }, "HydratedTrackedObjectSearch" : { "type" : "object", "description" : "Saved Custom Detection search with its query", "properties" : { "objectSearchQuery" : { "$ref" : "#/components/schemas/ObjectSearchQuery" }, "trackedObjectSearch" : { "$ref" : "#/components/schemas/TrackedObjectSearch" } } }, "IAperioType" : { "type" : "object", "description" : "The updated Aperio integration configuration.", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IAudioUserConfig" : { "type" : "object", "description" : "Audio gateway configuration settings", "properties" : { "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, "audio_analysis_enabled" : { "type" : "boolean", "nullable" : true }, "audio_analysis_params" : { "$ref" : "#/components/schemas/AudioParamConfig" }, "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_mic_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_internal_speaker_volume" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_min_echo_amplitude" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "audio_record" : { "type" : "boolean", "nullable" : true }, "audio_supported" : { "type" : "boolean", "nullable" : true }, "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, "cloud_archive_days" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cloud_archive_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "cloud_archive_upload_schedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, "cloud_archive_upload_schedule_inverted" : { "type" : "boolean", "nullable" : true }, "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "device_mic_enabled" : { "type" : "boolean", "nullable" : true }, "device_near_audio_silenced" : { "type" : "boolean", "nullable" : true }, "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, "event_clip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "frontendEqualizerHighShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerLowShelf" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking1" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking2" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendEqualizerPeaking3" : { "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, "led_mode_when_active" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_mode_when_inactive" : { "$ref" : "#/components/schemas/LEDModeEnum" }, "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, "live_license_invalid" : { "type" : "boolean", "nullable" : true }, "max_event_duration_ms" : { "type" : "integer", "format" : "int32", "nullable" : true }, "media_ttl_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "snapshot_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "splice_clip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" }, "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true }, "thumbstrip_upload_target" : { "$ref" : "#/components/schemas/UploadTargetEnum" } } }, "IAvigilonAltaType" : { "type" : "object", "description" : "Avigilon Alta V2 integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorToCameraMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "eventToWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "eventToWebhookMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/WebhookMapEntry" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "IBaseIntegrationType" : { "type" : "object", "discriminator" : { "propertyName" : "integration" }, "oneOf" : [ { "$ref" : "#/components/schemas/AperioType" }, { "$ref" : "#/components/schemas/AvigilonAltaType" }, { "$ref" : "#/components/schemas/BoulevardType" }, { "$ref" : "#/components/schemas/BrivoType" }, { "$ref" : "#/components/schemas/ButterflyMXType" }, { "$ref" : "#/components/schemas/DeviceIntegrationType" }, { "$ref" : "#/components/schemas/DiceType" }, { "$ref" : "#/components/schemas/EnvoyType" }, { "$ref" : "#/components/schemas/FlicType" }, { "$ref" : "#/components/schemas/GeneaType" }, { "$ref" : "#/components/schemas/GoogleType" }, { "$ref" : "#/components/schemas/GuestManagementType" }, { "$ref" : "#/components/schemas/HoneywellElementsType" }, { "$ref" : "#/components/schemas/InformacastType" }, { "$ref" : "#/components/schemas/InnerRangeType" }, { "$ref" : "#/components/schemas/KisiType" }, { "$ref" : "#/components/schemas/LumeoType" }, { "$ref" : "#/components/schemas/MicrosoftTeamsType" }, { "$ref" : "#/components/schemas/NineOneOneCellularType" }, { "$ref" : "#/components/schemas/OmnialertType" }, { "$ref" : "#/components/schemas/OpenAIType" }, { "$ref" : "#/components/schemas/OpentechAllianceType" }, { "$ref" : "#/components/schemas/PimlocType" }, { "$ref" : "#/components/schemas/PlaceOsType" }, { "$ref" : "#/components/schemas/ProDataKeyType" }, { "$ref" : "#/components/schemas/RaptorType" }, { "$ref" : "#/components/schemas/ShellyType" }, { "$ref" : "#/components/schemas/ToastType" }, { "$ref" : "#/components/schemas/WebhooksType" }, { "$ref" : "#/components/schemas/ZapierType" }, { "$ref" : "#/components/schemas/ParPOSType" }, { "$ref" : "#/components/schemas/HoneywellOnGuardType" }, { "$ref" : "#/components/schemas/HoneywellNetBoxType" }, { "$ref" : "#/components/schemas/SignatureApiType" } ], "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IBoulevardType" : { "type" : "object", "description" : "Boulevard integration settings", "properties" : { "accessWindowAfterMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "accessWindowBeforeMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "boulevardBusinessId" : { "type" : "string", "nullable" : true }, "boulevardLocationToRhombusLocationMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IBrivoType" : { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "nullable" : true }, "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiKey" : { "type" : "string", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "clientId" : { "type" : "string", "nullable" : true }, "clientSecret" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "username" : { "type" : "string", "nullable" : true }, "version" : { "type" : "integer", "format" : "int32", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "IButterflyMXType" : { "type" : "object", "description" : "ButterflyMX V2 integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "buildingWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "panelInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ButterflymxPanelInfoType" }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IClimateUserConfig" : { "type" : "object", "description" : "Climate sensor configuration", "properties" : { "accelerometer_change_tamper_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "accelerometer_disabled" : { "type" : "boolean", "nullable" : true }, "alert_window_minutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pressure_switch_tamper_disabled" : { "type" : "boolean", "nullable" : true }, "smoke_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "thc_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, "vape_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true } } }, "IDeviceIntegrationType" : { "type" : "object", "description" : "Device integration settings to update", "properties" : { "deviceSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DeviceIntegrationSettings" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IDiceType" : { "type" : "object", "description" : "Dice access control integration settings to update", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IEnvoyType" : { "type" : "object", "description" : "Envoy V2 integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "envoyIntegrationInstalled" : { "type" : "boolean", "nullable" : true }, "envoyUserSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EnvoyUserSettings" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "locationInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EnvoyLocationInfoType" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IFlicType" : { "type" : "object", "description" : "Flic smart button integration settings to update", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "apiSecret" : { "type" : "string", "nullable" : true }, "associatedLocations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "moduleUploaded" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookId" : { "type" : "string", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IGeneaType" : { "type" : "object", "description" : "Genea V2 integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true }, "webhookUuid" : { "type" : "string", "nullable" : true } } }, "IGoogleType" : { "type" : "object", "description" : "Google V2 integration settings to update", "properties" : { "allowUserStorage" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "defaultAlertFolderId" : { "type" : "string", "nullable" : true }, "defaultAlertFolderName" : { "type" : "string", "nullable" : true }, "defaultFolderId" : { "type" : "string", "nullable" : true }, "defaultFolderName" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/GoogleUserSettings" }, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IGuestManagementType" : { "type" : "object", "description" : "Guest management integration settings to update", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "locationSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/LocationSettings" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IHoneywellElementsType" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiKey" : { "type" : "string", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "baseUrl" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "siteId" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IHoneywellNetBoxType" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "baseUrl" : { "type" : "string", "nullable" : true }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IHoneywellOnGuardType" : { "type" : "object", "properties" : { "deploymentToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OnGuardDeploymentSettings" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IInformacastType" : { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "locationSiteMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InformacastSite" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IInnerRangeType" : { "type" : "object", "description" : "InnerRange access control integration settings to update", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "consoleToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InnerRangeConsoleSettings" }, "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InnerRangeDoorInfoType" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "skyTunnelSN" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IKisiType" : { "type" : "object", "description" : "Kisi V2 integration settings to update", "properties" : { "apiSecretKey" : { "type" : "string", "nullable" : true }, "defaultOptions" : { "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "placeToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationSettings" }, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ILumeoType" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IMicrosoftTeamsType" : { "type" : "object", "properties" : { "adminConsent" : { "type" : "boolean", "nullable" : true }, "allowUserNotifications" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "microsoftTeamSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" }, "nullable" : true }, "microsoftTeamsUserSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tenantId" : { "type" : "string", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "INineOneOneCellularType" : { "type" : "object", "description" : "911 Cellular emergency notification integration settings to update", "properties" : { "bearerToken" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "securityZoneMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SecurityZoneInfoType" }, "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "zonesValidated" : { "type" : "boolean", "nullable" : true } } }, "IOmnialertType" : { "type" : "object", "description" : "Omnialert emergency notification integration settings to update", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IOpenAIType" : { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "baseUrl" : { "type" : "string", "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", "nullable" : true }, "defaultModel" : { "type" : "string", "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IOpentechAllianceType" : { "type" : "object", "description" : "OpenTech Alliance V2 integration settings to update", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "apiSecret" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "facilityToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" }, "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IPimlocType" : { "type" : "object", "properties" : { "baseAPIUrl" : { "$ref" : "#/components/schemas/PimlocBaseAPIUrlEnum" }, "clientId" : { "type" : "string", "nullable" : true }, "clientSecret" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "validCredentials" : { "type" : "boolean", "nullable" : true } } }, "IPlaceOsType" : { "type" : "object", "description" : "PlaceOS V2 smart building management integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "apiUrl" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true } } }, "IProDataKeyType" : { "type" : "object", "description" : "Pro Data Key (PDK) V2 integration settings to update", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiToken" : { "type" : "string", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "indexFaces" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "organizationId" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "systemId" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookId" : { "type" : "string", "nullable" : true }, "webhookSignatureSecret" : { "type" : "string", "nullable" : true } } }, "IRModesEnum" : { "type" : "string", "enum" : [ "ON", "OFF", "AUTO" ] }, "IRaptorType" : { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "clientId" : { "type" : "string", "nullable" : true }, "clientSecret" : { "type" : "string", "nullable" : true }, "clientUid" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IShellyType" : { "type" : "object", "description" : "Shelly smart device integration settings to update", "properties" : { "canSendDiagnosticNotifications" : { "type" : "boolean", "nullable" : true }, "diagnosticQuietPeriodSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "shellyDeviceMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ShellyDevice" }, "nullable" : true }, "thirdPartyDeviceToLocationMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IToastType" : { "type" : "object", "properties" : { "currentToastRestaurantGuid" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "restaurantSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ToastRestaurantSettings" }, "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IWebhooksType" : { "type" : "object", "description" : "Updated webhook V2 integration settings", "properties" : { "activityWebhooks" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "activityWebhooksV2" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/WebhookInfo" }, "nullable" : true }, "diagnosticWebhooks" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "diagnosticWebhooksV2" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/WebhookInfo" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ImmixSettings" : { "type" : "object", "properties" : { "deviceList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "serverUrl" : { "type" : "string", "nullable" : true } } }, "InactivityObjectTypeEnum" : { "type" : "string", "enum" : [ "HUMAN", "VEHICLE" ] }, "IncidentReport" : { "type" : "object", "description" : "An incident report containing information about the incident.", "properties" : { "contributors" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ReportContributor" }, "description" : "Users who have contributed to the report, including its creator, keyed by user UUID.", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the report was created, in milliseconds since the epoch.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "generationFinishedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Time when system generation of the report completed, in milliseconds since the epoch. Only system-generated reports carry this timestamp, and it stays null until generation completes. A report without it may be missing timeline entries. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "generationStartedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Time when system generation of the report started, in milliseconds since the epoch. Only system-generated reports carry this timestamp, and it stays null until generation starts. A report carrying it without a generationFinishedAtMs may still be generating. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "locationName" : { "type" : "string", "description" : "Location name at the time the report was created, or null when the report has no location. It may differ from the current location name. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, "systemGenerated" : { "type" : "boolean", "description" : "Whether the report was generated by the system rather than created by a user.", "nullable" : true }, "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "title" : { "type" : "string", "description" : "Title of the incident report.", "maxLength" : 200, "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the report was last updated, in milliseconds since the epoch.", "nullable" : true }, "updatedBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IncidentReportAnnotation" : { "type" : "object", "description" : "A note attached to an incident report timeline entry, optionally pinned to a position on the entry's image.", "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the annotation was created, in milliseconds since the epoch.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "position" : { "$ref" : "#/components/schemas/AnnotationPosition" }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the annotation.", "maxLength" : 5000, "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the annotation was last updated, in milliseconds since the epoch.", "nullable" : true }, "updatedBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IncidentReportAnnotationSelectiveUpdate" : { "type" : "object", "description" : "Fields of an incident report annotation to update. Only the fields supplied are changed.", "properties" : { "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "position" : { "$ref" : "#/components/schemas/AnnotationPosition" }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the annotation.", "maxLength" : 5000, "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "entryUuid", "reportUuid", "uuid" ] }, "IncidentReportFilter" : { "type" : "object", "description" : "Filtering criteria for incident reports.", "properties" : { "contributorUuids" : { "type" : "array", "description" : "Filters incident reports by contributor. Reports with contributions from any of the specified users match.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "createdAtFilter" : { "$ref" : "#/components/schemas/EventTimestampFilter" }, "incidentReportStatuses" : { "type" : "array", "description" : "Filters incident reports by status. Reports with any of the specified statuses match.", "items" : { "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, "nullable" : true, "uniqueItems" : true }, "locationUuids" : { "type" : "array", "description" : "Filters incident reports by location. Reports at any of the specified locations match.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "systemGenerated" : { "type" : "boolean", "description" : "Filters incident reports by whether they were generated by the system. Null applies no filter.", "nullable" : true } } }, "IncidentReportNote" : { "type" : "object", "description" : "A note attached to an incident report.", "properties" : { "createdAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the note was created, in milliseconds since the epoch.", "nullable" : true }, "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "text" : { "type" : "string", "description" : "Text content of the note.", "maxLength" : 5000, "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the note was last updated, in milliseconds since the epoch.", "nullable" : true }, "updatedBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IncidentReportStatusEnum" : { "type" : "string", "description" : "Incident report status.", "enum" : [ "OPEN", "CLOSED" ] }, "IncomingWebhookRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "displayName" : { "type" : "string", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "Inference_GetPersonReidentificationEmbeddingFromImageWSResponse" : { "type" : "object", "description" : "Response for Person Reidentification embedding from image.", "properties" : { "embedding" : { "type" : "array", "description" : "Reidentification embedding for the uploaded image", "items" : { "type" : "number", "format" : "double", "description" : "Reidentification embedding for the uploaded image", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Inference_SegmentWithBoxesWSResponse" : { "type" : "object", "description" : "Response for segmentation using box prompts.", "properties" : { "boxesXyxy" : { "type" : "array", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "items" : { "type" : "array", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "items" : { "type" : "number", "format" : "float", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "nullable" : true }, "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "imageHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the input image in pixels.", "nullable" : true }, "imageWidth" : { "type" : "integer", "format" : "int32", "description" : "Width of the input image in pixels.", "nullable" : true }, "maskFormat" : { "type" : "string", "description" : "Format of the returned masks (ex: png_base64).", "nullable" : true }, "masks" : { "type" : "array", "description" : "Base64-encoded mask images.", "items" : { "type" : "string", "description" : "Base64-encoded mask images.", "nullable" : true }, "nullable" : true }, "scores" : { "type" : "array", "description" : "Confidence score for each returned mask.", "items" : { "type" : "number", "format" : "float", "description" : "Confidence score for each returned mask.", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Inference_SegmentWithPointsWSResponse" : { "type" : "object", "description" : "Response for segmentation using point prompts.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "imageHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the input image in pixels.", "nullable" : true }, "imageWidth" : { "type" : "integer", "format" : "int32", "description" : "Width of the input image in pixels.", "nullable" : true }, "labels" : { "type" : "string", "description" : "Point labels payload that was provided.", "nullable" : true }, "maskFormat" : { "type" : "string", "description" : "Format of the returned masks (ex: png_base64).", "nullable" : true }, "masks" : { "type" : "array", "description" : "Base64-encoded mask images.", "items" : { "type" : "string", "description" : "Base64-encoded mask images.", "nullable" : true }, "nullable" : true }, "points" : { "type" : "string", "description" : "Point coordinates payload that was provided.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Inference_SegmentWithTextWSResponse" : { "type" : "object", "description" : "Response for segmentation using a text prompt.", "properties" : { "boxesXyxy" : { "type" : "array", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "items" : { "type" : "array", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "items" : { "type" : "number", "format" : "float", "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "nullable" : true }, "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "imageHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the input image in pixels.", "nullable" : true }, "imageWidth" : { "type" : "integer", "format" : "int32", "description" : "Width of the input image in pixels.", "nullable" : true }, "maskFormat" : { "type" : "string", "description" : "Format of the returned masks (ex: png_base64).", "nullable" : true }, "masks" : { "type" : "array", "description" : "Base64-encoded mask images.", "items" : { "type" : "string", "description" : "Base64-encoded mask images.", "nullable" : true }, "nullable" : true }, "scores" : { "type" : "array", "description" : "Confidence score for each returned mask.", "items" : { "type" : "number", "format" : "float", "description" : "Confidence score for each returned mask.", "nullable" : true }, "nullable" : true }, "text" : { "type" : "string", "description" : "The text prompt used for segmentation.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "InformacastScenario" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "locationEnabled" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "InformacastSite" : { "type" : "object", "nullable" : true, "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "InformacastType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "locationSiteMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InformacastSite" }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "InnerRangeConsoleSettings" : { "type" : "object", "nullable" : true, "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InnerRangeDoorInfoType" }, "nullable" : true }, "skyTunnelSN" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } }, "InnerRangeConsoleType" : { "type" : "object", "properties" : { "doorList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InnerRangeDoorType" }, "nullable" : true }, "skyTunnelSN" : { "type" : "string", "nullable" : true } } }, "InnerRangeDoorInfoType" : { "type" : "object", "nullable" : true, "properties" : { "assignedCameraList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "clipDuration" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorName" : { "type" : "string", "nullable" : true }, "leadingSeconds" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "readerIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "remoteUnlock" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "InnerRangeDoorType" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "readerIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "InnerRangeType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "consoleToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InnerRangeConsoleSettings" }, "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InnerRangeDoorInfoType" }, "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "skyTunnelSN" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedDoorPositionIndicatorType" : { "type" : "object", "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "dpiType" : { "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedDoorRelayType" : { "type" : "object", "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/DoorRelayPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "rateLimitingEnabled" : { "type" : "boolean", "nullable" : true }, "relayType" : { "$ref" : "#/components/schemas/DoorRelayEnumType" }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedGenericButtonType" : { "type" : "object", "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "buttonType" : { "$ref" : "#/components/schemas/ButtonEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/ButtonModeEnum" }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/ButtonPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedGenericInputType" : { "type" : "object", "properties" : { "auxType" : { "$ref" : "#/components/schemas/AuxiliaryEnumType" }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/AuxiliaryInputPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedGenericRelayType" : { "type" : "object", "properties" : { "auxType" : { "$ref" : "#/components/schemas/AuxiliaryEnumType" }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/AuxiliaryRelayPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "relayDurationSec" : { "type" : "integer", "format" : "int32", "deprecated" : true, "description" : "Deprecated, do not use.", "nullable" : true }, "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "steadyState" : { "$ref" : "#/components/schemas/GenericRelayStateEnumType" }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegratedRequestToExitType" : { "type" : "object", "properties" : { "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "intentOnly" : { "type" : "boolean", "nullable" : true }, "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "normalState" : { "$ref" : "#/components/schemas/NormalStateEnumType" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/RequestToExitPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "rexType" : { "$ref" : "#/components/schemas/RequestToExitEnumType" }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegrationActionStatusEnum" : { "type" : "string", "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "UNKNOWN" ] }, "IntegrationAuditEvent" : { "type" : "object", "properties" : { "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "integrationAuditEvent" : { "$ref" : "#/components/schemas/IntegrationAuditEventEnum" }, "user" : { "type" : "string", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegrationAuditEventEnum" : { "type" : "string", "enum" : [ "UPDATE", "DELETE" ] }, "IntegrationCommandActionType" : { "type" : "object", "properties" : { "commandPayload" : { "type" : "string", "nullable" : true }, "delaySecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" } } }, "IntegrationDiagnosticEventType" : { "type" : "object", "properties" : { "activity" : { "$ref" : "#/components/schemas/DiagnosticActivityEnum" }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "thirdPartyDeviceId" : { "type" : "string", "nullable" : true }, "thirdPartyDeviceName" : { "type" : "string", "nullable" : true }, "timestamp" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntegrationEnum" : { "type" : "string", "enum" : [ "AVIGILON_ALTA", "BOULEVARD", "BRIVO", "BUTTERFLY_MX", "DEVICE_INTEGRATION", "DICE", "ENVOY", "FLIC", "GENEA", "GOOGLE", "HONEYWELL_ELEMENTS", "GUEST_MANAGEMENT", "INFORMACAST", "INNER_RANGE", "KISI", "LUMEO", "MICROSOFT_TEAMS", "OMNIALERT", "OPENAI", "OPENTECH_ALLIANCE", "PIMLOC", "PLACE_OS", "PRODATAKEY", "SHELLY", "TOAST", "WEBHOOKS", "ZAPIER", "RAPTOR", "NINEONEONE_CELLULAR", "SLACK", "APERIO", "PAR_POS", "HONEYWELL_ONGUARD", "HONEYWELL_NETBOX", "SIGNATURE_API", "UNKNOWN" ] }, "IntegrationNotificationActionType" : { "type" : "object", "properties" : { "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "notificationEntity" : { "type" : "string", "nullable" : true }, "notificationTarget" : { "type" : "string", "nullable" : true } } }, "IntegrationStateTypeEnum" : { "type" : "string", "enum" : [ "HONEYWELL_ONGUARD_VIDEO", "UNKNOWN" ] }, "Integration_BaseIntegrationWSRequest" : { "type" : "object", "description" : "Base request object for integration operations." }, "Integration_ConnectHoneywellElementsWSRequest" : { "type" : "object", "description" : "Step 1 of the Elements setup wizard: validate the API key against Honeywell Elements and persist on success. Subsequent endpoints (sites, devices, update) resolve credentials from the stored row and never require the API key again.", "properties" : { "apiKey" : { "type" : "string", "description" : "Honeywell Elements API key to validate and store.", "nullable" : true }, "baseUrl" : { "type" : "string", "description" : "Optional Elements API base URL. Defaults to https://api.elementssecure.com.", "nullable" : true } } }, "Integration_ConnectHoneywellNetBoxIntegrationWSResponse" : { "type" : "object", "description" : "Result of activating or updating the Honeywell NetBox integration. Returns the webhook URL and token to configure on the NetBox webhook forwarder. The token is stable across re-calls so the configured forwarder keeps working when the door mapping changes.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "Integration_ConnectHoneywellNetBoxWSRequest" : { "type" : "object", "description" : "Activate the Honeywell NetBox integration for the calling org. NetBox is webhook-driven: the on-prem NetBox controller POSTs access events to a Rhombus webhook URL. On first activation, omit any token; the server generates a webhook rhombusToken and returns it (plus the fully-formed webhook URL) for the customer to paste into the NetBox webhook forwarder. Subsequent calls preserve the existing token so the configured forwarder keeps working as the door mapping changes. The request owns the door mapping; map keys are the stable NetBox portal identifiers and values follow the standard Rhombus badge-integration door info shape.", "properties" : { "baseUrl" : { "type" : "string", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true } } }, "Integration_CreateEnvoyInviteWSRequest" : { "type" : "object", "properties" : { "invitation" : { "$ref" : "#/components/schemas/EnvoyInvite" } } }, "Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSRequest" : { "type" : "object", "description" : "Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory, while the console owns camera/location assignments. On first activation omit rhombusToken; the server generates the webhook token and returns it. On re-calls pass the token back; the reported door map is merged by portal key — new keys are added unmapped, existing keys get their display name refreshed, console-made camera/location/behavior assignments are never overwritten, and keys absent from the request (e.g. manually-added portals) are preserved.", "properties" : { "baseUrl" : { "type" : "string", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true } } }, "Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSResponse" : { "type" : "object", "description" : "Result of activating/updating the Honeywell NetBox integration from the on-prem side. Mirrors the OnGuard response shape, minus the pre-shared HMAC secret (the NetBox webhook is token-only).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest" : { "type" : "object", "description" : "Idempotent create-or-update of one OnGuard deployment for the calling org. An org can have multiple deployments connected at the same time (separate panels, MSP tenants, etc.) — each deployment is identified by its own rhombusToken. On first activation for a deployment, omit rhombusToken; the server generates one and returns it in the response. On subsequent calls, send the previously-returned rhombusToken to update the same deployment's door mapping in place. Map keys are the OnGuard door identifiers; values follow the standard Rhombus badge-integration door info shape.", "properties" : { "displayName" : { "type" : "string", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true } } }, "Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse" : { "type" : "object", "description" : "Result of activating or updating the Honeywell OnGuard integration. Returns the webhook URL, token, and pre-shared secret to configure on the OnGuard side. Token and secret are stable across re-calls so the deployed DLL keeps working when the door mapping changes.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "presharedSecret" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "Integration_DeleteHoneywellOnGuardIntegrationWSRequest" : { "type" : "object", "description" : "Delete one OnGuard deployment (when rhombusToken is provided) or the entire OnGuard integration row including every deployment (when rhombusToken is omitted).", "properties" : { "rhombusToken" : { "type" : "string", "nullable" : true } } }, "Integration_GetAccessControlIntegrationsForAlmWSResponse" : { "type" : "object", "properties" : { "badDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "integrations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetAllGuestsWSResponse" : { "type" : "object", "properties" : { "allGuests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Guest" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetAllOrgIntegrationsV2WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgIntegrationsV2" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IBaseIntegrationType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetAmtReadersWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "password" : { "type" : "string", "nullable" : true } } }, "Integration_GetAperioIntegrationWSRequest" : { "type" : "object", "description" : "Request object for retrieving Aperio integration configuration." }, "Integration_GetAperioIntegrationWSResponse" : { "type" : "object", "description" : "Response object containing Aperio integration configuration and door controllers.", "properties" : { "aperioSettings" : { "$ref" : "#/components/schemas/IAperioType" }, "doorControllers" : { "type" : "array", "description" : "List of Rhombus door controllers with Aperio integration", "items" : { "$ref" : "#/components/schemas/Integration_aperio_AperioRhombusDoorControllerView" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetApiTokenApplicationsWSRequest" : { "type" : "object" }, "Integration_GetApiTokenApplicationsWSResponse" : { "type" : "object", "properties" : { "applications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTokenApplicationType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetApiTokensWSRequest" : { "type" : "object", "description" : "Request object for retrieving API tokens.", "properties" : { "optionalFilter" : { "type" : "array", "description" : "Optional filter for API client types", "items" : { "$ref" : "#/components/schemas/ApiClientTypeEnum" }, "nullable" : true } } }, "Integration_GetApiTokensWSResponse" : { "type" : "object", "description" : "Response object containing API tokens.", "properties" : { "apiTokens" : { "type" : "array", "description" : "List of API tokens", "items" : { "$ref" : "#/components/schemas/ApiTokenType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetBadgeIntegrationDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetBadgeIntegrationGenericDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GenericDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetBadgeIntegrationPlacesWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "places" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetBoulevardIntegrationWSResponse" : { "type" : "object", "description" : "Response object for retrieving Boulevard integration settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "settings" : { "$ref" : "#/components/schemas/IBoulevardType" }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "description" : "Webhook URL for Boulevard to send notifications to", "nullable" : true } } }, "Integration_GetBrivoDoorsWSRequest" : { "type" : "object", "properties" : { "password" : { "type" : "string", "nullable" : true }, "username" : { "type" : "string", "nullable" : true } } }, "Integration_GetBrivoDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetButterflymxPanelsWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "password" : { "type" : "string", "nullable" : true } } }, "Integration_GetButterflymxPanelsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "buildings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ButterflymxBuilding" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetCalendlyEventDetailsWSRequest" : { "type" : "object", "properties" : { "eventUuid" : { "type" : "string", "nullable" : true } } }, "Integration_GetCalendlyEventDetailsWSResponse" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "endTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "startTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetEnvoyDeliveriesWSRequest" : { "type" : "object", "properties" : { "endTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "startTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Integration_GetEnvoyDeliveriesWSResponse" : { "type" : "object", "properties" : { "collectedDeliveries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyDelivery" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "pendingDeliveries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyDelivery" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetEnvoyEmployeesWSRequest" : { "type" : "object", "properties" : { "locationIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "Integration_GetEnvoyEmployeesWSResponse" : { "type" : "object", "properties" : { "employees" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyPersonInfo" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetEnvoyLocationsWSRequest" : { "type" : "object" }, "Integration_GetEnvoyLocationsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyLocation" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetEnvoyVisitorsWSRequest" : { "type" : "object", "properties" : { "endTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "includeSignedOutVisitors" : { "type" : "boolean", "nullable" : true }, "locationIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "startTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Integration_GetEnvoyVisitorsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invites" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyExpectedGuest" }, "nullable" : true }, "visitors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnvoyGuest" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetFlicDevicesWSRequest" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetFlicDevicesWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flicDevices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FlicDevice" }, "nullable" : true }, "flicModule" : { "$ref" : "#/components/schemas/FlicDevice" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetGeneaDoorsWSRequest" : { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true } } }, "Integration_GetGeneaDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "panelList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PanelType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetGuestWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellElementsDevicesWSRequest" : { "type" : "object", "description" : "Fetch Honeywell Elements devices. Optional siteId overrides the persisted site — used by the wizard's site dropdown to preview devices for a site without first saving.", "properties" : { "siteId" : { "type" : "string", "description" : "Optional Elements site ID. When omitted, the persisted siteId from the integration row is used.", "nullable" : true } } }, "Integration_GetHoneywellElementsDevicesWSResponse" : { "type" : "object", "properties" : { "devices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSResponse_ElementsDevice" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellElementsDevicesWSResponse_ElementsDevice" : { "type" : "object", "properties" : { "deviceType" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "siteId" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellElementsSitesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sites" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_GetHoneywellElementsSitesWSResponse_ElementsSite" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellElementsSitesWSResponse_ElementsSite" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellElementsWebhookConfigWSResponse" : { "type" : "object", "description" : "Fully-formed callback URL and suggested payload template for configuring the webhook Automation in the Honeywell Elements admin console.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "payloadTemplate" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "Integration_GetHoneywellNetBoxWebhookConfigWSResponse" : { "type" : "object", "description" : "Fully-formed callback URL and suggested payload template for configuring a webhook forwarder in the Honeywell NetBox admin console.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "payloadTemplate" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "Integration_GetInformacastScenariosWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "scenarios" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InformacastScenario" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetInformacastSitesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "sites" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InformacastSite" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetInnerRangeConsolesWSRequest" : { "type" : "object" }, "Integration_GetInnerRangeConsolesWSResponse" : { "type" : "object", "properties" : { "consoles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InnerRangeConsoleType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetInnerRangeDoorsWSRequest" : { "type" : "object" }, "Integration_GetInnerRangeDoorsWSResponse" : { "type" : "object", "properties" : { "doors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InnerRangeDoorType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetIntegrationDiagnosticEventsWSRequest" : { "type" : "object", "properties" : { "timestampMsAfter" : { "type" : "integer", "format" : "int64", "nullable" : true }, "timestampMsBefore" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Integration_GetIntegrationDiagnosticEventsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "integrationDiagnosticEvents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IntegrationDiagnosticEventType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetKisiDoorsWSRequest" : { "type" : "object", "properties" : { "apiSecretKey" : { "type" : "string", "nullable" : true } } }, "Integration_GetKisiDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "placeToDoorMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorType" }, "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetKisiIntegrationWSResponse" : { "type" : "object", "description" : "Response object containing Kisi integration settings.", "properties" : { "authError" : { "type" : "boolean", "description" : "Whether an authentication error occurred during update", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedGuids" : { "type" : "array", "description" : "List of GUIDs that failed to update", "items" : { "type" : "string", "description" : "List of GUIDs that failed to update", "nullable" : true }, "nullable" : true }, "kisiSettings" : { "$ref" : "#/components/schemas/KisiSettings" }, "misconfiguredDoors" : { "type" : "array", "description" : "List of door names that are assigned to multiple Rhombus locations", "items" : { "type" : "string", "description" : "List of door names that are assigned to multiple Rhombus locations", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetKisiPlacesWSRequest" : { "type" : "object", "properties" : { "apiSecretKey" : { "type" : "string", "nullable" : true } } }, "Integration_GetMicrosoftUsersJoinedTeamsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "teamsMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetNineOneOneCSZonesWSRequest" : { "type" : "object" }, "Integration_GetNineOneOneCSZonesWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zone" : { "$ref" : "#/components/schemas/SecurityZoneInfoType" }, "zoneMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SecurityZoneInfoType" }, "nullable" : true } } }, "Integration_GetOpenAIModelsWSRequest" : { "type" : "object", "description" : "Request object for retrieving OpenAI models.", "properties" : { "openAISettings" : { "$ref" : "#/components/schemas/IOpenAIType" } } }, "Integration_GetOpenAIModelsWSResponse" : { "type" : "object", "description" : "Response object containing available OpenAI models.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "models" : { "type" : "array", "description" : "List of available OpenAI models", "items" : { "$ref" : "#/components/schemas/OpenAIModel" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetOpenpathDoorsWSRequest" : { "type" : "object", "properties" : { "email" : { "type" : "string", "nullable" : true }, "password" : { "type" : "string", "nullable" : true } } }, "Integration_GetOpenpathLockdownsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetOpentechAllianceFacilitiesWSRequest" : { "type" : "object" }, "Integration_GetOpentechAllianceFacilitiesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "facilities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OpentechAllianceFacilityType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetOrgIntegrationsV2WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgIntegrationV2" : { "$ref" : "#/components/schemas/IBaseIntegrationType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetOrgIntegrationsWSRequest" : { "type" : "object", "description" : "Request object for retrieving organization integrations." }, "Integration_GetOrgIntegrationsWSResponse" : { "type" : "object", "description" : "Response object containing organization integrations configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgIntegrations" : { "$ref" : "#/components/schemas/OrgIntegrationsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetPartnerApiTokensWSRequest" : { "type" : "object" }, "Integration_GetPdkDoorsWSRequest" : { "type" : "object", "properties" : { "ouId" : { "type" : "string", "nullable" : true } } }, "Integration_GetPdkDoorsWSResponse" : { "type" : "object", "properties" : { "authError" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "panelList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PanelType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetPdkSystemIdWSRequest" : { "type" : "object", "properties" : { "configurationToken" : { "type" : "string", "nullable" : true } } }, "Integration_GetPdkSystemIdWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "systemId" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetPlaceOsDoorsWSRequest" : { "type" : "object", "properties" : { "apiUrl" : { "type" : "string", "nullable" : true } } }, "Integration_GetRaptorBuildingsWSResponse" : { "type" : "object", "properties" : { "buildings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RaptorBuilding" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetRaptorTemplatesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "templates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RaptorTemplate" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastEventsTableAllLocationsWSRequest" : { "type" : "object", "properties" : { "businessDate" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastEventsTableAllLocationsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "eventTable" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" }, "nullable" : true }, "failedGuids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastEventsTableWSRequest" : { "type" : "object", "properties" : { "businessDate" : { "type" : "string", "nullable" : true }, "restaurantGuid" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastEventsTableWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "eventTable" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastEventsTableWSResponse_EventTableRow" : { "type" : "object", "properties" : { "assignedCameraList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "employeeName" : { "type" : "string", "nullable" : true }, "orderGuid" : { "type" : "string", "nullable" : true }, "paymentType" : { "type" : "string", "nullable" : true }, "restaurantName" : { "type" : "string", "nullable" : true }, "revenueCenterName" : { "type" : "string", "nullable" : true }, "serviceAreaName" : { "type" : "string", "nullable" : true }, "timestamp" : { "type" : "string", "nullable" : true }, "tipAmount" : { "type" : "string", "nullable" : true }, "totalAmount" : { "type" : "string", "nullable" : true }, "totalDiscountAmount" : { "type" : "string", "nullable" : true }, "voided" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastServiceAreasWSRequest" : { "type" : "object", "properties" : { "restaurantGuid" : { "type" : "string", "nullable" : true } } }, "Integration_GetToastServiceAreasWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "serviceAreas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GenericPosType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_GuestWSRequest" : { "type" : "object", "description" : "Request object for guest-related operations.", "properties" : { "email" : { "type" : "string", "description" : "Email address of the guest", "example" : "guest@example.com", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_HoneywellOnGuardDeploymentSummaryType" : { "type" : "object", "description" : "Summary of one OnGuard deployment. Never includes the pre-shared secret; the deployment is identified by its rhombusToken, which is also what deleteHoneywellOnGuardIntegration takes.", "properties" : { "assignedCameraUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "doorCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rhombusToken" : { "type" : "string", "nullable" : true } } }, "Integration_InitiateBrivoOAuthWSRequest" : { "type" : "object", "description" : "Request object for initiating Brivo OAuth authentication flow with API key.", "properties" : { "apiKey" : { "type" : "string", "description" : "Brivo Mashery API key obtained from Brivo Developer Portal", "example" : "brivo_api_key_12345", "nullable" : true }, "param" : { "type" : "string", "description" : "Additional OAuth parameter", "example" : "state_param", "nullable" : true }, "requestUrl" : { "type" : "string", "description" : "OAuth request URL", "example" : "https://oauth.provider.com/auth", "nullable" : true }, "rhombusOrgUserUuid" : { "type" : "string", "description" : "Rhombus organization user UUID", "nullable" : true } } }, "Integration_InitiateCallbackAuthRequest" : { "type" : "object", "properties" : { "rhombusOrgUserUuid" : { "type" : "string", "nullable" : true } } }, "Integration_InitiateCallbackAuthResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "integratorUrl" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_InitiateOAuthWSRequest" : { "type" : "object", "description" : "Request object for initiating OAuth authentication flow.", "properties" : { "param" : { "type" : "string", "description" : "Additional OAuth parameter", "example" : "state_param", "nullable" : true }, "requestUrl" : { "type" : "string", "description" : "OAuth request URL", "example" : "https://oauth.provider.com/auth", "nullable" : true }, "rhombusOrgUserUuid" : { "type" : "string", "description" : "Rhombus organization user UUID", "nullable" : true } } }, "Integration_InitiateOAuthWSResponse" : { "type" : "object", "description" : "Response object containing OAuth redirect URL.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "redirectUrl" : { "type" : "string", "description" : "OAuth redirect URL for authentication", "example" : "https://oauth.provider.com/auth?client_id=123&redirect_uri=callback", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_ListHoneywellOnGuardIntegrationsWSRequest" : { "type" : "object", "description" : "List the calling org's OnGuard deployments. Takes no parameters today; the body is reserved for future filters/paging." }, "Integration_ListHoneywellOnGuardIntegrationsWSResponse" : { "type" : "object", "description" : "The calling org's OnGuard deployments. Empty list when the integration has never been activated or every deployment has been deleted.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "integrations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_HoneywellOnGuardDeploymentSummaryType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_RefreshGoogleAccessTokenWSRequest" : { "type" : "object", "description" : "Request object for refreshing Google access token.", "properties" : { "refreshUserToken" : { "type" : "boolean", "description" : "Whether to refresh the user token", "example" : true, "nullable" : true } } }, "Integration_RefreshGoogleAccessTokenWSResponse" : { "type" : "object", "description" : "Response object containing refreshed Google access token.", "properties" : { "accessToken" : { "type" : "string", "description" : "Refreshed Google access token", "example" : "ya29.a0AfH6SMC...", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_RevokeApiTokenWSRequest" : { "type" : "object", "description" : "Request object for revoking an API token.", "properties" : { "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_RevokeApiTokenWSResponse" : { "type" : "object", "description" : "Response object for revoking an API token.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_RevokeGoogleDriveAccessWSRequest" : { "type" : "object", "description" : "Request object for revoking Google Drive access permissions.", "properties" : { "revokeUserAccount" : { "type" : "boolean", "description" : "If set to true, revokes Rhombus Systems access to a user's Google Drive account, otherwise revokes Rhombus Systems access to the org's shared Google Drive account", "example" : true, "nullable" : true } } }, "Integration_SendShellyCommandResultEnumType" : { "type" : "string", "description" : "Outcome of a manually sent Shelly command.", "enum" : [ "SUCCESS", "DEVICE_OFFLINE", "NOT_AUTHORIZED", "DEVICE_BUSY", "FAILED" ] }, "Integration_SendShellyCommandWSRequest" : { "type" : "object", "description" : "Request object for manually sending a command to a Shelly device.", "properties" : { "channel" : { "type" : "integer", "format" : "int32", "description" : "Channel to address on a multi-channel device. Defaults to the first channel", "example" : 0, "nullable" : true }, "command" : { "$ref" : "#/components/schemas/Integration_ShellyCommandEnumType" }, "deviceId" : { "type" : "string", "description" : "Shelly device ID, as keyed in the org's Shelly integration settings", "example" : "e8db84d1f2a0", "nullable" : true } } }, "Integration_SendShellyCommandWSResponse" : { "type" : "object", "description" : "Response object for manually sending a command to a Shelly device.", "properties" : { "canSendCommands" : { "$ref" : "#/components/schemas/ShellyDevicePermissionEnum" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "isOnline" : { "type" : "boolean", "description" : "Whether the device was reachable during the attempt", "example" : true, "nullable" : true }, "result" : { "$ref" : "#/components/schemas/Integration_SendShellyCommandResultEnumType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_ShellyCommandEnumType" : { "type" : "string", "description" : "Command to send to a Shelly relay or light.", "enum" : [ "TURN_ON", "TURN_OFF", "TOGGLE" ] }, "Integration_SubmitApiTokenApplicationWSRequest" : { "type" : "object", "description" : "Request object for submitting an API token application.", "properties" : { "authType" : { "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" }, "csr" : { "type" : "string", "description" : "Certificate Signing Request (CSR) for token authentication", "example" : "-----BEGIN CERTIFICATE REQUEST-----...", "nullable" : true }, "displayName" : { "type" : "string", "description" : "Display name for the API token", "example" : "Production API Token", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "permissionGroupUuid" ] }, "Integration_SubmitApiTokenApplicationWSResponse" : { "type" : "object", "properties" : { "apiKey" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "cert" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "validCSR" : { "type" : "boolean", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_SubscribeZapierWebhookWSRequest" : { "type" : "object", "description" : "Request object for subscribing to Zapier webhook events.", "properties" : { "backoffSec" : { "type" : "integer", "format" : "int32", "description" : "Backoff time in seconds", "example" : 30, "nullable" : true }, "doorState" : { "$ref" : "#/components/schemas/DoorStatusEnum" }, "hookUrl" : { "type" : "string", "description" : "Zapier webhook URL", "example" : "https://hooks.zapier.com/hooks/catch/123456/abc123/", "nullable" : true }, "humidityLowerThreshold" : { "type" : "number", "format" : "float", "description" : "Lower humidity threshold for environmental sensors", "example" : 30.0, "nullable" : true }, "humidityUpperThreshold" : { "type" : "number", "format" : "float", "description" : "Upper humidity threshold for environmental sensors", "example" : 80.0, "nullable" : true }, "tempLowerThreshold" : { "type" : "number", "format" : "float", "description" : "Lower temperature threshold for environmental sensors", "example" : 65.0, "nullable" : true }, "tempUpperThreshold" : { "type" : "number", "format" : "float", "description" : "Upper temperature threshold for environmental sensors", "example" : 85.5, "nullable" : true }, "uuids" : { "type" : "array", "description" : "Set of device UUIDs to monitor", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "zapEnum" : { "$ref" : "#/components/schemas/ZapierEnum" } } }, "Integration_SubscribeZapierWebhookWSResponse" : { "type" : "object", "description" : "Response object for Zapier webhook subscription.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_TestBoulevardConnectionWSRequest" : { "type" : "object", "description" : "Request object for testing Boulevard API connection.", "properties" : { "apiToken" : { "type" : "string", "description" : "Boulevard API token to test", "nullable" : true }, "boulevardBusinessId" : { "type" : "string", "description" : "Boulevard business ID to test", "nullable" : true } } }, "Integration_TestBoulevardConnectionWSResponse" : { "type" : "object", "description" : "Response object for testing Boulevard API connection.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMessage" : { "type" : "string", "description" : "Error message if connection test failed", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locations" : { "type" : "array", "description" : "List of Boulevard locations available for the business", "items" : { "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" }, "nullable" : true }, "success" : { "type" : "boolean", "description" : "Whether the connection test was successful", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" : { "type" : "object", "description" : "Information about a Boulevard location.", "properties" : { "id" : { "type" : "string", "description" : "Boulevard location ID", "nullable" : true }, "name" : { "type" : "string", "description" : "Boulevard location name", "nullable" : true } } }, "Integration_TogglePowerWSRequest" : { "type" : "object", "description" : "Request object for toggling device power state.", "properties" : { "deviceId" : { "type" : "string", "description" : "Device ID to toggle power for", "example" : "device_12345", "nullable" : true }, "targetState" : { "type" : "integer", "format" : "int32", "description" : "Target power state (0=off, 1=on)", "example" : 1, "nullable" : true } } }, "Integration_TogglePowerWSResponse" : { "type" : "object", "description" : "Response object for device power toggle operations.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "newState" : { "type" : "integer", "format" : "int32", "description" : "New power state after toggle (0=off, 1=on)", "example" : 1, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_UnlockDoorWSResponse" : { "type" : "object", "description" : "Response object for door unlock operations.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_UnlockGeneaDoorWSRequest" : { "type" : "object", "description" : "Request object for unlocking a Genea door.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorId" : { "type" : "string", "description" : "Genea door ID to unlock", "example" : "door_12345", "nullable" : true } } }, "Integration_UnlockIntegrationGenericDoorWSRequest" : { "type" : "object", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorId" : { "type" : "string", "nullable" : true } } }, "Integration_UnlockKisiDoorWSRequest" : { "type" : "object", "description" : "Request object for unlocking a Kisi door.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorId" : { "type" : "integer", "format" : "int32", "description" : "Kisi door ID to unlock", "example" : 12345, "nullable" : true }, "placeId" : { "type" : "integer", "format" : "int32", "description" : "Kisi place ID representing the physical space", "example" : 67890, "nullable" : true } } }, "Integration_UnlockOpenpathDoorWSRequest" : { "type" : "object", "description" : "Request object for unlocking an Openpath door.", "properties" : { "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorId" : { "type" : "integer", "format" : "int32", "description" : "Openpath door ID to unlock", "example" : 12345, "nullable" : true } } }, "Integration_UnsubscribeZapierWebhookWSRequest" : { "type" : "object", "description" : "Request object for unsubscribing from a Zapier webhook.", "properties" : { "webhookId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_UpdateAmtIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating AMT access control integration settings.", "properties" : { "amtSettings" : { "$ref" : "#/components/schemas/AmtSettings" } } }, "Integration_UpdateAperioIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Aperio integration configuration.", "properties" : { "aperioSettings" : { "$ref" : "#/components/schemas/IAperioType" } }, "required" : [ "aperioSettings" ] }, "Integration_UpdateApiTokenWSRequest" : { "type" : "object", "description" : "Request object for updating API token properties.", "properties" : { "newDisplayName" : { "type" : "string", "description" : "New display name for the API token", "example" : "Updated API Token", "nullable" : true }, "newPermissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_UpdateApiTokenWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_UpdateAvigilonAltaV2WSRequest" : { "type" : "object", "description" : "Request object for updating Avigilon Alta V2 integration settings.", "properties" : { "avigilonAltaSettings" : { "$ref" : "#/components/schemas/IAvigilonAltaType" } } }, "Integration_UpdateAwsIntegrationWSRequest" : { "type" : "object", "properties" : { "awsSettings" : { "$ref" : "#/components/schemas/AwsSettings" } } }, "Integration_UpdateBoulevardIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Boulevard access control integration settings.", "properties" : { "accessWindowAfterMinutes" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes after appointment to allow access", "nullable" : true }, "accessWindowBeforeMinutes" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes before appointment to allow access", "nullable" : true }, "apiToken" : { "type" : "string", "description" : "Boulevard API token", "nullable" : true }, "boulevardBusinessId" : { "type" : "string", "description" : "Boulevard business ID", "nullable" : true }, "boulevardLocationToRhombusLocationMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "description" : "Mapping of Boulevard location IDs to Rhombus location UUIDs", "nullable" : true }, "enabled" : { "type" : "boolean", "description" : "Whether the Boulevard integration is enabled", "nullable" : true } } }, "Integration_UpdateBoxIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Box file storage integration settings.", "properties" : { "boxSettings" : { "$ref" : "#/components/schemas/BoxSettings" } } }, "Integration_UpdateBrivoIntegrationV2WSRequest" : { "type" : "object", "properties" : { "brivoSettings" : { "$ref" : "#/components/schemas/IBrivoType" } } }, "Integration_UpdateBrivoIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Brivo access control integration settings.", "properties" : { "brivoSettings" : { "$ref" : "#/components/schemas/BrivoSettings" } } }, "Integration_UpdateButterflymxIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating ButterflyMX V2 integration settings with enhanced intercom features.", "properties" : { "butterflymxSettings" : { "$ref" : "#/components/schemas/IButterflyMXType" } } }, "Integration_UpdateButterflymxIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating ButterflyMX intercom integration settings.", "properties" : { "settings" : { "$ref" : "#/components/schemas/ButterflyMXSettings" } } }, "Integration_UpdateDeviceIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating device integration settings and device properties.", "properties" : { "createNewDevice" : { "type" : "boolean", "description" : "Whether to create a new device", "example" : true, "nullable" : true }, "deviceIntegrationSettings" : { "$ref" : "#/components/schemas/IDeviceIntegrationType" }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the device location", "example" : 37.7749, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the device location", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the device", "example" : "Main Entrance Camera", "nullable" : true }, "updateDevice" : { "type" : "boolean", "description" : "Whether to update an existing device", "example" : false, "nullable" : true }, "updateDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_UpdateDiceIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Dice access control integration settings.", "properties" : { "diceSettings" : { "$ref" : "#/components/schemas/IDiceType" } } }, "Integration_UpdateDropboxIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Dropbox integration settings.", "properties" : { "dropboxSettings" : { "$ref" : "#/components/schemas/DropboxSettingsV2" } } }, "Integration_UpdateEmailIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating email notification integration settings.", "properties" : { "emailSettings" : { "$ref" : "#/components/schemas/EmailSettings" } } }, "Integration_UpdateEnvoyIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Envoy V2 integration settings with enhanced visitor management features.", "properties" : { "envoySettings" : { "$ref" : "#/components/schemas/IEnvoyType" } } }, "Integration_UpdateEnvoyIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Envoy visitor management integration settings.", "properties" : { "envoySettings" : { "$ref" : "#/components/schemas/EnvoySettings" } } }, "Integration_UpdateFlicIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Flic smart button integration settings.", "properties" : { "flicSettings" : { "$ref" : "#/components/schemas/IFlicType" } } }, "Integration_UpdateGeneaIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Genea V2 integration settings with enhanced access control features.", "properties" : { "geneaSettings" : { "$ref" : "#/components/schemas/IGeneaType" } } }, "Integration_UpdateGeneaIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Genea access control integration settings.", "properties" : { "geneaSettings" : { "$ref" : "#/components/schemas/GeneaSettings" } } }, "Integration_UpdateGoogleIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Google V2 integration settings with enhanced features.", "properties" : { "googleSettings" : { "$ref" : "#/components/schemas/IGoogleType" } } }, "Integration_UpdateGoogleIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Google integration settings.", "properties" : { "googleSettings" : { "$ref" : "#/components/schemas/GoogleSettings" } } }, "Integration_UpdateGuestByTokenWSRequest" : { "type" : "object", "description" : "Request object for updating guest information using a token.", "properties" : { "fileName" : { "type" : "string", "description" : "File name for guest-related data", "example" : "guest_data.csv", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "token" : { "type" : "string", "description" : "Token for guest identification and authentication", "example" : "guest_token_12345", "nullable" : true } } }, "Integration_UpdateGuestManagementIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating guest management integration settings.", "properties" : { "guestManagementSettings" : { "$ref" : "#/components/schemas/IGuestManagementType" } } }, "Integration_UpdateGuestWSRequest" : { "type" : "object", "properties" : { "fileName" : { "type" : "string", "description" : "File name for guest-related data", "example" : "guest_data.csv", "nullable" : true }, "guest" : { "$ref" : "#/components/schemas/Guest" }, "sendGuestEmail" : { "type" : "boolean", "nullable" : true } } }, "Integration_UpdateHaloIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Halo access control integration settings.", "properties" : { "haloSettings" : { "$ref" : "#/components/schemas/HaloSettings" } } }, "Integration_UpdateHoneywellElementsIntegrationWSRequest" : { "type" : "object", "properties" : { "honeywellElementsSettings" : { "$ref" : "#/components/schemas/IHoneywellElementsType" } } }, "Integration_UpdateHoneywellNetBoxIntegrationWSRequest" : { "type" : "object", "properties" : { "honeywellNetBoxSettings" : { "$ref" : "#/components/schemas/IHoneywellNetBoxType" } } }, "Integration_UpdateHoneywellOnGuardIntegrationWSRequest" : { "type" : "object", "properties" : { "honeywellOnGuardSettings" : { "$ref" : "#/components/schemas/IHoneywellOnGuardType" } } }, "Integration_UpdateInformacastIntegrationRequest" : { "type" : "object", "properties" : { "informacastSettings" : { "$ref" : "#/components/schemas/IInformacastType" } } }, "Integration_UpdateInnerRangeIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating InnerRange access control integration settings.", "properties" : { "innerRangeSettings" : { "$ref" : "#/components/schemas/IInnerRangeType" } } }, "Integration_UpdateIntuifaceIntegrationWSRequest" : { "type" : "object", "properties" : { "settings" : { "$ref" : "#/components/schemas/IntuifaceSettings" } } }, "Integration_UpdateKisiIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Kisi V2 integration settings with enhanced features.", "properties" : { "kisiSettings" : { "$ref" : "#/components/schemas/IKisiType" } } }, "Integration_UpdateKisiIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Kisi access control integration settings.", "properties" : { "kisiSettings" : { "$ref" : "#/components/schemas/KisiSettings" } } }, "Integration_UpdateLumeoIntegrationWSRequest" : { "type" : "object", "properties" : { "lumeoSettings" : { "$ref" : "#/components/schemas/ILumeoType" } } }, "Integration_UpdateMattermostIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Mattermost team communication integration settings.", "properties" : { "mattermostSettings" : { "$ref" : "#/components/schemas/MattermostSettings" } } }, "Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" : { "type" : "object", "properties" : { "teamId" : { "type" : "string", "nullable" : true } } }, "Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" : { "type" : "object", "properties" : { "microsoftTeamsSettings" : { "$ref" : "#/components/schemas/IMicrosoftTeamsType" }, "teamsToUpdate" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "Integration_UpdateMicrosoftTeamsIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Microsoft Teams integration settings.", "properties" : { "microsoftTeamsSettings" : { "$ref" : "#/components/schemas/MicrosoftTeamsSettings" } } }, "Integration_UpdateNineOneOneCellularIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating 911 Cellular emergency notification integration settings.", "properties" : { "nineOneOneCellularSettings" : { "$ref" : "#/components/schemas/INineOneOneCellularType" } } }, "Integration_UpdateNoonlightSettingsWSRequest" : { "type" : "object", "properties" : { "noonlightSettings" : { "$ref" : "#/components/schemas/NoonlightSettings" } } }, "Integration_UpdateOffice365IntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Office 365 integration settings.", "properties" : { "office365Settings" : { "$ref" : "#/components/schemas/Office365Settings" } } }, "Integration_UpdateOmnialertIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Omnialert emergency notification integration settings.", "properties" : { "omnialertSettings" : { "$ref" : "#/components/schemas/IOmnialertType" } } }, "Integration_UpdateOmnialertIntegrationWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Integration_UpdateOpenAIIntegrationRequest" : { "type" : "object", "properties" : { "openAISettings" : { "$ref" : "#/components/schemas/IOpenAIType" } } }, "Integration_UpdateOpenpathIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Openpath access control integration settings.", "properties" : { "openpathSettings" : { "$ref" : "#/components/schemas/OpenpathSettings" } } }, "Integration_UpdateOpentechAllianceIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating OpenTech Alliance V2 integration settings with enhanced features.", "properties" : { "opentechAllianceSettings" : { "$ref" : "#/components/schemas/IOpentechAllianceType" } } }, "Integration_UpdateOpentechAllianceIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating OpenTech Alliance integration settings.", "properties" : { "opentechAllianceSettings" : { "$ref" : "#/components/schemas/OpentechAllianceSettings" } } }, "Integration_UpdateOrgIntegrationsWSResponse" : { "type" : "object", "description" : "Response object for updating organization integrations.", "properties" : { "authError" : { "type" : "boolean", "description" : "Whether an authentication error occurred during update", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedGuids" : { "type" : "array", "description" : "List of GUIDs that failed to update", "items" : { "type" : "string", "description" : "List of GUIDs that failed to update", "nullable" : true }, "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "description" : "List of door names that are assigned to multiple Rhombus locations", "items" : { "type" : "string", "description" : "List of door names that are assigned to multiple Rhombus locations", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_UpdatePagerDutyIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating PagerDuty incident management integration settings.", "properties" : { "pagerDutySettings" : { "$ref" : "#/components/schemas/PagerDutySettings" } } }, "Integration_UpdatePdkIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Pro Data Key (PDK) V2 integration settings with enhanced access control features.", "properties" : { "pdkSettings" : { "$ref" : "#/components/schemas/IProDataKeyType" } } }, "Integration_UpdatePdkIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Pro Data Key (PDK) integration settings.", "properties" : { "pdkSettings" : { "$ref" : "#/components/schemas/ProDataKeySettings" } } }, "Integration_UpdatePimlocIntegrationRequest" : { "type" : "object", "properties" : { "pimlocSettings" : { "$ref" : "#/components/schemas/IPimlocType" } } }, "Integration_UpdatePlaceOsSettingsV2WSRequest" : { "type" : "object", "description" : "Request object for updating PlaceOS V2 integration settings for smart building management.", "properties" : { "placeOsSettings" : { "$ref" : "#/components/schemas/IPlaceOsType" } } }, "Integration_UpdatePlaceOsSettingsWSRequest" : { "type" : "object", "properties" : { "placeOsSettings" : { "$ref" : "#/components/schemas/PlaceOsSettings" } } }, "Integration_UpdateRaptorIntegrationRequest" : { "type" : "object", "properties" : { "raptorSettings" : { "$ref" : "#/components/schemas/IRaptorType" } } }, "Integration_UpdateServiceNowIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating ServiceNow IT service management integration settings.", "properties" : { "serviceNowSettings" : { "$ref" : "#/components/schemas/ServiceNowSettings" } } }, "Integration_UpdateShellyIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Shelly smart device integration settings.", "properties" : { "shellySettings" : { "$ref" : "#/components/schemas/IShellyType" } } }, "Integration_UpdateSlackIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating Slack integration V2 settings with enhanced user management.", "properties" : { "adminRequest" : { "type" : "boolean", "description" : "Whether this is an admin request", "example" : true, "nullable" : true }, "requestUrl" : { "type" : "string", "description" : "Request URL for Slack OAuth", "example" : "https://slack.com/oauth/v2/authorize?client_id=123&scope=...", "nullable" : true }, "revokeUserAccessToken" : { "type" : "boolean", "description" : "Whether to revoke user access token", "example" : false, "nullable" : true }, "rhombusOrgUserUuid" : { "type" : "string", "description" : "Rhombus organization user UUID", "example" : "user-uuid-12345", "nullable" : true }, "slackSettingsV2" : { "$ref" : "#/components/schemas/SlackSettingsV2" }, "userAssociate" : { "type" : "boolean", "description" : "Whether to associate user", "example" : true, "nullable" : true }, "userRequest" : { "type" : "boolean", "description" : "Whether this is a user request", "example" : false, "nullable" : true } }, "required" : [ "requestUrl" ] }, "Integration_UpdateSlackIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Slack integration settings.", "properties" : { "slackSettings" : { "$ref" : "#/components/schemas/SlackSettings" } } }, "Integration_UpdateToastIntegrationV2WSRequest" : { "type" : "object", "properties" : { "restaurantGuids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "toastSettings" : { "$ref" : "#/components/schemas/IToastType" } } }, "Integration_UpdateToastIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Toast POS integration settings.", "properties" : { "toastSettings" : { "$ref" : "#/components/schemas/ToastSettings" } } }, "Integration_UpdateTritonIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating Triton audio sensor integration settings.", "properties" : { "tritonSettings" : { "$ref" : "#/components/schemas/TritonSettings" } } }, "Integration_UpdateWebhookIntegrationV2WSRequest" : { "type" : "object", "description" : "Request object for updating webhook V2 integration settings with enhanced configuration options.", "properties" : { "disabled" : { "type" : "boolean", "description" : "Whether the webhook is disabled", "example" : false, "nullable" : true }, "isDiagnostic" : { "type" : "boolean", "description" : "Whether this is a diagnostic webhook", "example" : false, "nullable" : true }, "updatedWebhookSettings" : { "$ref" : "#/components/schemas/IWebhooksType" }, "webhookUrl" : { "type" : "string", "description" : "Webhook URL for receiving notifications", "example" : "https://api.example.com/webhook/rhombus", "nullable" : true } } }, "Integration_UpdateWebhookIntegrationV2WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "webhookSecret" : { "type" : "string", "nullable" : true } } }, "Integration_UpdateWebhookIntegrationWSRequest" : { "type" : "object", "description" : "Request object for updating webhook integration settings.", "properties" : { "webhookSettings" : { "$ref" : "#/components/schemas/WebhookSettings" } } }, "Integration_ValidateHoneywellElementsCredentialsWSRequest" : { "type" : "object", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "baseUrl" : { "type" : "string", "nullable" : true } } }, "Integration_ValidateKisiApiKeyWSRequest" : { "type" : "object", "description" : "Request object for validating Kisi API key.", "properties" : { "apiKey" : { "type" : "string", "description" : "Kisi API key to validate", "example" : "kisi_api_key_123456789", "nullable" : true } } }, "Integration_aperio_AperioDeviceView" : { "type" : "object", "description" : "View object containing Aperio device information.", "properties" : { "aperioId" : { "type" : "array", "description" : "Aperio device ID", "items" : { "type" : "string", "format" : "byte", "description" : "Aperio device ID", "nullable" : true }, "nullable" : true }, "gatewayId" : { "type" : "array", "description" : "Gateway ID associated with the device", "items" : { "type" : "string", "format" : "byte", "description" : "Gateway ID associated with the device", "nullable" : true }, "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the device was last seen", "example" : 1642233600000, "nullable" : true }, "rawType" : { "type" : "string", "format" : "byte", "description" : "Raw device type", "example" : "MQ==", "nullable" : true } } }, "Integration_aperio_AperioDoorView" : { "type" : "object", "description" : "View object containing Aperio door information and status.", "properties" : { "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "aperioDoorDeviceId" : { "type" : "string", "description" : "Aperio door device ID", "nullable" : true }, "aperioGatewayId" : { "type" : "string", "description" : "Aperio gateway ID that brokers communication with this door", "nullable" : true }, "aperioId" : { "type" : "string", "description" : "Aperio door ID (device group ID) for controlling the locking mechanism", "nullable" : true }, "connected" : { "type" : "boolean", "description" : "Whether the Aperio door is currently connected", "example" : true, "nullable" : true }, "doorExtensionComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dtcs" : { "type" : "array", "description" : "List of diagnostic trouble codes (DTCs) for the door", "items" : { "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" }, "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the door was last seen", "example" : 1642233600000, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the Aperio door", "example" : "Main Entrance", "nullable" : true }, "rawActivatorState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawDoorMode" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawHandleState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawKeyCylinderState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "rawTamperState" : { "type" : "integer", "format" : "int32", "nullable" : true }, "removed" : { "type" : "boolean", "description" : "Whether the door has been removed from the gateway", "example" : false, "nullable" : true }, "stateUpdateEventTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" } } }, "Integration_aperio_AperioGatewayView" : { "type" : "object", "description" : "View object containing Aperio gateway information and status.", "properties" : { "aperioGatewayId" : { "type" : "string", "description" : "Aperio gateway ID (device interface unit ID)", "nullable" : true }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "connected" : { "type" : "boolean", "description" : "Whether the Aperio gateway is currently connected", "example" : true, "nullable" : true }, "devices" : { "type" : "array", "description" : "List of Aperio devices associated with this gateway", "items" : { "$ref" : "#/components/schemas/Integration_aperio_AperioDeviceView" }, "nullable" : true }, "doors" : { "type" : "array", "description" : "List of Aperio doors associated with this gateway", "items" : { "$ref" : "#/components/schemas/Integration_aperio_AperioDoorView" }, "nullable" : true }, "dtcs" : { "type" : "array", "description" : "List of diagnostic trouble codes (DTCs) for the gateway", "items" : { "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" }, "nullable" : true }, "expectedOemCode" : { "type" : "string", "description" : "Expected OEM code for the gateway (only available after system configuration)", "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version of the Aperio gateway", "example" : "1.2.3", "nullable" : true }, "hardwareModel" : { "type" : "string", "nullable" : true }, "hwVersion" : { "type" : "array", "description" : "Hardware version of the Aperio gateway", "items" : { "type" : "string", "format" : "byte", "description" : "Hardware version of the Aperio gateway", "nullable" : true }, "nullable" : true }, "ipAddress" : { "type" : "string", "description" : "IP address of the Aperio gateway", "example" : "192.168.1.100", "nullable" : true }, "lastSeenMs" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the gateway was last seen", "example" : 1642233600000, "nullable" : true }, "protocolVersion" : { "type" : "string", "description" : "Protocol version of the Aperio gateway", "example" : "1.0.0", "nullable" : true }, "rawTamperState" : { "type" : "integer", "format" : "int32", "description" : "Raw tamper state of the Aperio gateway", "example" : 0, "nullable" : true }, "reportedOemCode" : { "type" : "string", "description" : "OEM code reported by the gateway for authenticity verification", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" } } }, "Integration_aperio_AperioIntegrationStatus" : { "type" : "string", "description" : "Integration status of the Aperio gateway", "enum" : [ "UNKNOWN", "DISCOVERED", "PAIRING", "CONFIGURED", "ERROR_OEM", "ERROR_OWNER" ] }, "Integration_aperio_AperioRhombusDoorControllerView" : { "type" : "object", "description" : "View object containing Rhombus door controller information for Aperio integration.", "properties" : { "aperioGateways" : { "type" : "array", "description" : "List of Aperio gateways associated with this door controller", "items" : { "$ref" : "#/components/schemas/Integration_aperio_AperioGatewayView" }, "nullable" : true }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "hwId" : { "type" : "string", "description" : "Hardware ID of the Rhombus door controller", "example" : "DC001", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "name" : { "type" : "string", "description" : "Name of the Rhombus door controller", "example" : "Main Door Controller", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the Rhombus door controller", "example" : "RHDC123456789", "nullable" : true } } }, "Integration_aperio_ClearAperioDtcWSRequest" : { "type" : "object", "description" : "Request object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", "properties" : { "aperioDeviceId" : { "type" : "string", "description" : "The Aperio device id (hex string) of the device to which this command is issued.", "nullable" : true }, "aperioGatewayId" : { "type" : "string", "description" : "The Aperio device id (hex string) of the gateway hosting the device.", "nullable" : true }, "controllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "registeredComponentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioDeviceId", "aperioGatewayId", "controllerUuid" ] }, "Integration_aperio_ClearAperioDtcWSResponse" : { "type" : "object", "description" : "Response object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_aperio_CreateAperioRs485GatewayWSRequest" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number of the RS-485 line the hub is wired to", "example" : 0, "nullable" : true }, "eacAddress" : { "type" : "integer", "format" : "int32", "description" : "The hub's base address on the line, 0x01 to 0x0F, set on its DIP switches. Its locks are addressed from there: a hub based at 0x01 has locks at 0x01, 0x11, 0x21 and so on, so two hubs on one line do not overlap.", "example" : 1, "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number of the RS-485 line the hub is wired to", "example" : 15, "nullable" : true } }, "required" : [ "eacAddress", "ownerDeviceUuid" ] }, "Integration_aperio_DownloadCertificateWSRequest" : { "type" : "object", "description" : "Request object for downloading Aperio certificate.", "properties" : { "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "ownerDeviceUuid" ] }, "Integration_aperio_DtcInfoView" : { "type" : "object", "description" : "View object containing Aperio diagnostic trouble code (DTC) information.", "properties" : { "code" : { "type" : "array", "description" : "DTC code as byte array", "items" : { "type" : "string", "format" : "byte", "description" : "DTC code as byte array", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "description" : "Whether the DTC represents an error condition", "example" : true, "nullable" : true }, "failing" : { "type" : "boolean", "description" : "Whether the DTC is currently failing", "example" : true, "nullable" : true }, "hasFailed" : { "type" : "boolean", "description" : "Whether the DTC has failed in the past", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Display name of the DTC", "example" : "Communication Error", "nullable" : true }, "testCompleted" : { "type" : "boolean", "description" : "Whether the DTC test has completed", "example" : true, "nullable" : true }, "time" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the DTC was reported (seconds since 1970-01-01)", "example" : 1642233600, "nullable" : true } } }, "Integration_aperio_RebootAperioGatewayWSRequest" : { "type" : "object", "description" : "Request object for rebooting an Aperio gateway.", "properties" : { "aperioGatewayId" : { "type" : "string", "description" : "The Aperio device id (hex string) of the gateway.", "nullable" : true }, "controllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "aperioGatewayId", "controllerUuid" ] }, "Integration_aperio_RebootAperioGatewayWSResponse" : { "type" : "object", "description" : "Response object for rebooting an Aperio gateway.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_schlage_CreateSchlageRs485GatewayWSRequest" : { "type" : "object", "properties" : { "baud" : { "type" : "integer", "format" : "int32", "description" : "Line speed. Optional: RSI fixes it at 9600, so this is an override for hardware that needs one.", "example" : 9600, "nullable" : true }, "boardNum" : { "type" : "integer", "format" : "int32", "description" : "Board number of the RS-485 line the gateway is wired to", "example" : 0, "nullable" : true }, "frameCheck" : { "$ref" : "#/components/schemas/Rs485FrameCheckEnum" }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "description" : "Port number of the RS-485 line the gateway is wired to", "example" : 15, "nullable" : true }, "rs485Address" : { "type" : "integer", "format" : "int32", "description" : "The gateway's RSD address on the line, 0x00 to 0xFE. 0xFF is the panel and 0xAA is the broadcast address, so neither names a gateway. Several gateways may share one line, each at its own address.", "example" : 1, "nullable" : true } }, "required" : [ "ownerDeviceUuid", "rs485Address" ] }, "Integration_state_FindIntegrationStateKeysWSRequest" : { "type" : "object", "description" : "Request to list the state keys present for (org, integrationType).", "properties" : { "integrationType" : { "$ref" : "#/components/schemas/IntegrationStateTypeEnum" } } }, "Integration_state_FindIntegrationStateKeysWSResponse" : { "type" : "object", "description" : "The state keys present for (org, integrationType); values are not returned.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "stateKeys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration_state_IntegrationStateKeyWSType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_state_GetIntegrationStateWSRequest" : { "type" : "object", "description" : "Request to read an org-scoped integration state entry.", "properties" : { "integrationType" : { "$ref" : "#/components/schemas/IntegrationStateTypeEnum" }, "stateKey" : { "type" : "string", "nullable" : true } } }, "Integration_state_GetIntegrationStateWSResponse" : { "type" : "object", "description" : "The stored state value, or a null stateValue when no entry exists (a normal condition, not an error).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "stateValue" : { "type" : "string", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Integration_state_IntegrationStateKeyWSType" : { "type" : "object", "description" : "A state key present for (org, integrationType).", "properties" : { "stateKey" : { "type" : "string", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "Integration_state_UpdateIntegrationStateWSRequest" : { "type" : "object", "description" : "Request to overwrite an org-scoped integration state entry.", "properties" : { "integrationType" : { "$ref" : "#/components/schemas/IntegrationStateTypeEnum" }, "stateKey" : { "type" : "string", "nullable" : true }, "stateValue" : { "type" : "string", "nullable" : true } } }, "Integration_state_UpdateIntegrationStateWSResponse" : { "type" : "object", "description" : "Result of an integration state write.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "IntelliGuardCoOccurrenceRule" : { "type" : "object", "properties" : { "alertAction" : { "type" : "boolean", "nullable" : true }, "cameraPositions" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CameraPosition" }, "nullable" : true }, "cameraScope" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "cooldownMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "disappearanceThresholdMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "faceNames" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "liveNotificationAction" : { "type" : "boolean", "nullable" : true }, "matchCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true }, "personUuids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "proximityMeters" : { "type" : "integer", "format" : "int64", "nullable" : true }, "scheduleIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteInterval" }, "nullable" : true }, "scheduleTimezone" : { "type" : "string", "nullable" : true }, "scheduleUuid" : { "type" : "string", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "nullable" : true }, "windowMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "IntelliGuardTailgatingRule" : { "type" : "object", "description" : "The tailgating rule to update, including its uuid. Required.", "properties" : { "alertAction" : { "type" : "boolean", "nullable" : true }, "authorizationSource" : { "type" : "string", "nullable" : true }, "bestEffort" : { "type" : "boolean", "nullable" : true }, "cameraScope" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "cooldownMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "crossingSource" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "doorScope" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "insideCameraUuid" : { "type" : "string", "nullable" : true }, "insideInwardActivity" : { "type" : "string", "nullable" : true }, "liveNotificationAction" : { "type" : "boolean", "nullable" : true }, "minExtraEntries" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true }, "outsideCameraUuid" : { "type" : "string", "nullable" : true }, "outsideInwardActivity" : { "type" : "string", "nullable" : true }, "ruleType" : { "type" : "string", "nullable" : true }, "scheduleIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WeeklyMinuteInterval" }, "nullable" : true }, "scheduleTimezone" : { "type" : "string", "nullable" : true }, "scheduleUuid" : { "type" : "string", "nullable" : true }, "transitionMaxGapMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "nullable" : true }, "windowMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "IntercomTalkEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "originator" : { "$ref" : "#/components/schemas/BaseEventOriginator" }, "state" : { "$ref" : "#/components/schemas/IntercomTalkStateEnumType" }, "talkSessionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "IntercomTalkStateEnumType" : { "type" : "string", "description" : "Whether the operator started or ended talking", "enum" : [ "STARTED", "ENDED" ] }, "Internal_AddPartnerAsSuperAdminWSRequest" : { "type" : "object", "description" : "Request object for adding a partner as a super admin to an organization.", "properties" : { "loginAccessAllowed" : { "type" : "boolean", "description" : "Whether login access is allowed for the partner", "example" : true, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "partnerEmail" : { "type" : "string", "description" : "Email address of the partner", "example" : "partner@company.com", "nullable" : true }, "partnerName" : { "type" : "string", "description" : "Name of the partner", "example" : "Partner Solutions Inc", "nullable" : true }, "partnerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Internal_AddPartnerAsSuperAdminWSResponse" : { "type" : "object", "description" : "Response object for adding a partner as a super admin to an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "superAdminGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_CreateCombinedLicensesFromV1WSRequest" : { "type" : "object", "properties" : { "accountDataMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" }, "nullable" : true } } }, "Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" : { "type" : "object", "properties" : { "opportunityIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true } } }, "Internal_CreateCombinedLicensesFromV1WSResponse" : { "type" : "object", "nullable" : true, "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedAccounts" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "successfulAccounts" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Internal_CreateOrgWSRequest" : { "type" : "object", "description" : "Request object for creating a new organization with account owner and company information.", "properties" : { "accountOwnerEmail" : { "type" : "string", "description" : "Email address of the account owner", "example" : "owner@company.com", "nullable" : true }, "accountOwnerName" : { "type" : "string", "description" : "Full name of the account owner", "example" : "John Smith", "nullable" : true }, "companyName" : { "type" : "string", "description" : "Name of the company or organization", "example" : "Acme Corporation", "nullable" : true }, "developmentPartnerOrg" : { "type" : "boolean", "description" : "Whether this is a development partner organization", "example" : false, "nullable" : true }, "licenseEntitlementEnabled" : { "type" : "boolean", "description" : "Whether license entitlement is enabled for this organization", "example" : true, "nullable" : true }, "salesforceId" : { "type" : "string", "description" : "Salesforce ID for the organization (sensitive field)", "nullable" : true }, "sendWelcomeEmail" : { "type" : "boolean", "description" : "Whether to send a welcome email to the account owner", "example" : true, "nullable" : true } } }, "Internal_CreateOrgWSResponse" : { "type" : "object", "description" : "Response object for creating a new organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_CreatePartnerOrgWSRequest" : { "type" : "object", "description" : "Request object for creating a new partner organization.", "properties" : { "accountOwnerEmail" : { "type" : "string", "description" : "Email address of the partner account owner", "example" : "partner@company.com", "nullable" : true }, "accountOwnerName" : { "type" : "string", "description" : "Full name of the partner account owner", "example" : "Sarah Wilson", "nullable" : true }, "companyName" : { "type" : "string", "description" : "Name of the partner company", "example" : "Partner Solutions Inc", "nullable" : true }, "salesforceId" : { "type" : "string", "description" : "Salesforce ID for the partner organization (sensitive field)", "nullable" : true }, "sendWelcomeEmail" : { "type" : "boolean", "description" : "Whether to send a welcome email to the partner account owner", "example" : true, "nullable" : true } } }, "Internal_CreatePartnerOrgWSResponse" : { "type" : "object", "description" : "Response object for creating a new partner organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_CreateReturnedInventoryAuditReservationWSRequest" : { "type" : "object", "description" : "Request object for creating a returned inventory audit reservation.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "miscNotes" : { "type" : "string", "description" : "Miscellaneous notes for the inventory audit (deprecated)", "example" : "Damaged packaging, missing accessories", "nullable" : true }, "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "returnType" : { "$ref" : "#/components/schemas/ReturnTypeEnum" }, "salesforceOppId" : { "type" : "string", "description" : "Salesforce opportunity ID for the inventory audit", "example" : "0061234567890ABC", "nullable" : true }, "trackingNumber" : { "type" : "string", "description" : "Tracking number for the returned inventory (deprecated)", "example" : "1Z999AA1234567890", "nullable" : true } } }, "Internal_CreateReturnedInventoryAuditReservationWSResponse" : { "type" : "object", "description" : "Response object for creating a returned inventory audit reservation.", "properties" : { "auditReservationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "auditReservationUuids" : { "type" : "array", "description" : "List of UUIDs for the created audit reservations", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_CreateSupportAuthorityWSRequest" : { "type" : "object", "description" : "Request object for creating a support authority.", "properties" : { "supportAuthority" : { "$ref" : "#/components/schemas/SupportAuthorityType" } } }, "Internal_CreateSupportAuthorityWSResponse" : { "type" : "object", "description" : "Response object for creating a support authority.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "supportAuthorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_DeveloperNewsletterEnrollWSRequest" : { "type" : "object", "description" : "Request object for enrolling in the developer newsletter.", "properties" : { "developerNewsletter" : { "type" : "boolean", "description" : "Whether to subscribe to the developer newsletter", "example" : true, "nullable" : true }, "email" : { "type" : "string", "description" : "Email address for newsletter subscription", "example" : "developer@company.com", "nullable" : true }, "firstName" : { "type" : "string", "description" : "First name of the subscriber", "example" : "Alex", "nullable" : true }, "isDeveloper" : { "type" : "boolean", "description" : "Whether the subscriber is a developer", "example" : true, "nullable" : true }, "lastName" : { "type" : "string", "description" : "Last name of the subscriber", "example" : "Johnson", "nullable" : true }, "orgName" : { "type" : "string", "description" : "Name of the organization", "example" : "TechCorp Solutions", "nullable" : true } } }, "Internal_DeveloperNewsletterEnrollWSResponse" : { "type" : "object", "description" : "Response object for developer newsletter enrollment.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_DeviceStateType" : { "type" : "object", "properties" : { "connected" : { "type" : "boolean", "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "name" : { "type" : "string", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true } } }, "Internal_GetActiveRMAsWSRequest" : { "type" : "object" }, "Internal_GetActiveRMAsWSResponse" : { "type" : "object", "properties" : { "activeRmasList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_GetDeviceStatesForOrgWSRequest" : { "type" : "object", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Internal_GetDeviceStatesForOrgWSResponse" : { "type" : "object", "properties" : { "deviceStates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Internal_DeviceStateType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_GetSuperAdminGroupUUIDWSRequest" : { "type" : "object", "description" : "Request object for getting the super admin group UUID for an organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Internal_GetSuperAdminGroupUUIDWSResponse" : { "type" : "object", "description" : "Response object for getting the super admin group UUID for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "superAdminGroupUUID" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_GetUserLoginActivityForOrgsWSRequest" : { "type" : "object", "description" : "Orgs to look up user login activity for. The window is always the last month.", "properties" : { "orgUuids" : { "type" : "array", "description" : "Org uuids to look up, 200 or fewer per request", "items" : { "type" : "string", "description" : "Org uuids to look up, 200 or fewer per request", "nullable" : true }, "nullable" : true } } }, "Internal_GetUserLoginActivityForOrgsWSResponse" : { "type" : "object", "description" : "Most recent user login per org within the last month", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failedOrgUuids" : { "type" : "array", "description" : "Org uuids we could not answer for - the lookup failed, or the uuid was not usable. This is NOT the same as 'no login': the answer is unknown, so leave any stored value untouched and retry on the next run. Recording them as inactive would be a wrong answer indistinguishable from a real one. Echoed back exactly as sent, so an unparseable value is identifiable; a JSON null in the request appears here as the literal \"(null)\".", "items" : { "type" : "string", "description" : "Org uuids we could not answer for - the lookup failed, or the uuid was not usable. This is NOT the same as 'no login': the answer is unknown, so leave any stored value untouched and retry on the next run. Recording them as inactive would be a wrong answer indistinguishable from a real one. Echoed back exactly as sent, so an unparseable value is identifiable; a JSON null in the request appears here as the literal \"(null)\".", "nullable" : true }, "nullable" : true }, "lastLoginMsByOrgUuid" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "description" : "Epoch millis of the most recent user login, for orgs that had one within the last month. Orgs with no login are NOT keys here - they are listed in noLoginOrgUuids. The map never contains null values: null map entries do not survive this service's response pipeline.", "nullable" : true }, "description" : "Epoch millis of the most recent user login, for orgs that had one within the last month. Orgs with no login are NOT keys here - they are listed in noLoginOrgUuids. The map never contains null values: null map entries do not survive this service's response pipeline.", "nullable" : true }, "noLoginOrgUuids" : { "type" : "array", "description" : "Org uuids that were queried successfully and had no user login within the last month. This is the authoritative 'not active in the last month' answer.", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_GetWarrantyApprovedRMAsWSRequest" : { "type" : "object" }, "Internal_GetWarrantyApprovedRMAsWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true }, "zendeskTickets" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Internal_InitiateShipmentWSRequest" : { "type" : "object", "description" : "Request object for initiating a shipment process.", "properties" : { "rhombusShipmentInfo" : { "$ref" : "#/components/schemas/RhombusShipmentInfoType" }, "salesforceOppId" : { "type" : "string", "description" : "Salesforce opportunity ID for the shipment", "example" : "0061234567890ABC", "nullable" : true }, "shipmentCategory" : { "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" }, "shipmentInfo" : { "$ref" : "#/components/schemas/OutgoingShipmentInfoType" } } }, "Internal_ListOrgsWSRequest" : { "type" : "object", "description" : "Request object for listing organizations." }, "Internal_ListOrgsWSResponse" : { "type" : "object", "description" : "Response object containing a list of organizations.", "properties" : { "orgs" : { "type" : "array", "description" : "List of organizations", "items" : { "$ref" : "#/components/schemas/OrgV2Type" }, "nullable" : true } } }, "Internal_ParentLifetimeSpendWSRequest" : { "type" : "object", "description" : "Request object for retrieving parent lifetime spend information.", "properties" : { "endAccountIdx" : { "type" : "integer", "format" : "int32", "description" : "Ending account index for the range", "example" : 100, "nullable" : true }, "startAccountIdx" : { "type" : "integer", "format" : "int32", "description" : "Starting account index for the range", "example" : 0, "nullable" : true } } }, "Internal_ParentLifetimeSpendWSResponse" : { "type" : "object", "description" : "Response object for parent lifetime spend information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_RemediateMissingFirstAssignedDatesWSRequest" : { "type" : "object", "properties" : { "orgUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, "Internal_RemediateMissingFirstAssignedDatesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "updateOrgUuidsToUpdatedLicenseUuids" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_RequestHardwareForDevelopmentWSRequest" : { "type" : "object", "description" : "Request object for requesting hardware for development purposes.", "properties" : { "address1" : { "type" : "string", "description" : "Street address line 1", "example" : "123 Main Street", "nullable" : true }, "city" : { "type" : "string", "description" : "City name", "example" : "San Francisco", "nullable" : true }, "companyName" : { "type" : "string", "description" : "Name of the company or organization", "example" : "Tech Startup Inc", "nullable" : true }, "country" : { "type" : "string", "description" : "Country name", "example" : "United States", "nullable" : true }, "email" : { "type" : "string", "description" : "Email address of the requester", "example" : "developer@company.com", "nullable" : true }, "firstName" : { "type" : "string", "description" : "First name of the requester", "example" : "Jane", "nullable" : true }, "jobTitle" : { "type" : "string", "description" : "Job title of the requester", "example" : "Senior Developer", "nullable" : true }, "lastName" : { "type" : "string", "description" : "Last name of the requester", "example" : "Doe", "nullable" : true }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the requester", "example" : "+1-555-123-4567", "nullable" : true }, "requestReason" : { "type" : "string", "description" : "Reason for requesting hardware for development", "example" : "Testing new camera integration features", "nullable" : true }, "state" : { "type" : "string", "description" : "State or province", "example" : "CA", "nullable" : true }, "zip" : { "type" : "string", "description" : "ZIP or postal code", "example" : "94105", "nullable" : true } } }, "Internal_RequestHardwareForDevelopmentWSResponse" : { "type" : "object", "description" : "Response object for hardware development request.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_SalesforceAccount" : { "type" : "object", "properties" : { "Admin_ID__c" : { "type" : "string", "nullable" : true } } }, "Internal_SalesforceOpportunity" : { "type" : "object", "properties" : { "Account" : { "$ref" : "#/components/schemas/Internal_SalesforceAccount" } } }, "Internal_SalesforceOpportunityLineItem" : { "type" : "object", "properties" : { "Opportunity" : { "$ref" : "#/components/schemas/Internal_SalesforceOpportunity" }, "OpportunityId" : { "type" : "string", "nullable" : true }, "ProductCode" : { "type" : "string", "nullable" : true }, "Quantity" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Internal_SendShipmentShippedEmailWSRequest" : { "type" : "object", "description" : "Request object for sending shipment shipped email notification.", "properties" : { "salesforceOppId" : { "type" : "string", "description" : "Salesforce opportunity ID for the shipment email", "example" : "0061234567890ABC", "nullable" : true } } }, "Internal_SendTrialEvaluationEmailWSRequest" : { "type" : "object", "properties" : { "contractEndDate" : { "type" : "string", "nullable" : true }, "opportunityOwnerEmail" : { "type" : "string", "nullable" : true }, "opportunityOwnerName" : { "type" : "string", "nullable" : true }, "orderNumber" : { "type" : "string", "nullable" : true }, "primaryContactEmail" : { "type" : "string", "nullable" : true }, "salesEngineerEmail" : { "type" : "string", "nullable" : true } } }, "Internal_SendTrialEvaluationEmailWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_SetOpportunityForPurchaseOrderWSRequest" : { "type" : "object", "description" : "Request object for setting opportunity information for a purchase order.", "properties" : { "cancellationReason" : { "type" : "string", "description" : "Reason for cancellation if the purchase order is not accepted", "example" : "Budget constraints", "nullable" : true }, "isAccepted" : { "type" : "boolean", "description" : "Whether the purchase order is accepted", "example" : true, "nullable" : true }, "purchaseOrderNumber" : { "type" : "string", "description" : "Purchase order number", "example" : "PO-2024-001", "nullable" : true }, "purchaseOrderUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "salesforceOppId" : { "type" : "string", "description" : "Salesforce opportunity ID (sensitive field)", "nullable" : true } } }, "Internal_SetOpportunityForPurchaseOrderWSResponse" : { "type" : "object", "description" : "Response object for setting opportunity information for a purchase order.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_ShipmentEmailWSResponse" : { "type" : "object", "description" : "Response object for shipment email operations.", "properties" : { "customerShipmentEmailState" : { "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "legacyMsg" : { "type" : "string", "description" : "Legacy message for the shipment email", "example" : "Shipment has been processed", "nullable" : true }, "trackingIdentifier" : { "type" : "string", "description" : "Tracking identifier for the shipment", "example" : "1Z999AA1234567890", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_VerifyCanMigrateOrgFromV1JsonWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" : { "type" : "object", "properties" : { "canMigrate" : { "type" : "boolean", "nullable" : true }, "errorMessages" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "licenseComparisons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LicenseComparisonEntry" }, "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true } } }, "Internal_VerifyCanMigrateOrgFromV1WSRequest" : { "type" : "object", "properties" : { "entries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" }, "nullable" : true } } }, "Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" : { "type" : "object", "properties" : { "opportunityIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "nullable" : true }, "productCodeToLicensesPurchasedMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true } } }, "Internal_VerifyCanMigrateOrgFromV1WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invalidOrgsToErrorMessages" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "orgLicenseComparisons" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LicenseComparisonEntry" }, "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "IntuifaceSettings" : { "type" : "object", "properties" : { "deviceToTriggerMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/TriggerContent" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "InvalidPhysicalPortConfigType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "componentUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "reason" : { "$ref" : "#/components/schemas/InvalidPhysicalPortReasonEnumType" } } }, "InvalidPhysicalPortReasonEnumType" : { "type" : "string", "enum" : [ "NON_EXISTANT_COMPONENT_BOARD_NUM", "NON_EXISTANT_COMPONENT_PORT_NUM", "CONFLICTING_COMPONENT_PORT_TYPES", "COMPONENT_PORT_TYPE_NOT_SUPPORTED_BY_PORT", "MAX_COMPONENTS_PER_PORT_TYPE_EXCEEDED" ] }, "InvoiceStatusEnum" : { "type" : "string", "enum" : [ "PAID", "UNPAID_PENDING", "UNPAID_OVERDUE", "CANCELLED" ] }, "InvoiceType" : { "type" : "object", "description" : "Invoice details and information", "properties" : { "addOnLicenseInvoices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AddOnLicenseInvoiceType" }, "nullable" : true }, "additionalEmails" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "attachCsv" : { "type" : "boolean", "nullable" : true }, "cameraPurchaseCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "cameraPurchasePrice" : { "type" : "number", "format" : "float", "nullable" : true }, "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "companyName" : { "type" : "string", "nullable" : true }, "customerAddress" : { "type" : "string", "nullable" : true }, "customerEmail" : { "type" : "string", "nullable" : true }, "customerName" : { "type" : "string", "nullable" : true }, "date" : { "type" : "integer", "format" : "int64", "nullable" : true }, "domePurchaseCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "domePurchasePrice" : { "type" : "number", "format" : "float", "nullable" : true }, "domeSubItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "dueDate" : { "type" : "integer", "format" : "int64", "nullable" : true }, "externalId" : { "type" : "string", "nullable" : true }, "installationPrice" : { "type" : "number", "format" : "float", "nullable" : true }, "license" : { "$ref" : "#/components/schemas/LicenseEnum" }, "licenseCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "licensePrice" : { "type" : "number", "format" : "float", "nullable" : true }, "licenseSubItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LicenseInvoiceSubItem" }, "nullable" : true }, "notes" : { "type" : "string", "nullable" : true }, "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "r1Camera1024" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "r1Camera512" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "r1CameraPurchaseCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "r1CameraPurchasePrice" : { "type" : "number", "format" : "float", "nullable" : true }, "r1CameraSubItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "r1LargeCameraPurchaseCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "r1LargeCameraPurchasePrice" : { "type" : "number", "format" : "float", "nullable" : true }, "r1LargeSubItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "r1MediumSubItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, "nullable" : true }, "salespersonName" : { "type" : "string", "nullable" : true }, "shippingPrice" : { "type" : "number", "format" : "float", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/InvoiceStatusEnum" }, "tax" : { "type" : "number", "format" : "float", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Invoice_InvoiceChargeV2WSRequest" : { "type" : "object", "description" : "Request object for charging an invoice.", "properties" : { "invoiceUuid" : { "type" : "string", "description" : "UUID of the invoice to charge", "nullable" : true }, "sourceToken" : { "type" : "string", "description" : "Payment source token for charging the invoice", "example" : "tok_1234567890abcdef", "nullable" : true } } }, "Invoice_InvoiceChargeWSRequest" : { "type" : "object", "description" : "Request object for charging an invoice.", "properties" : { "invoiceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sourceToken" : { "type" : "string", "description" : "Payment source token for charging the invoice", "example" : "tok_1234567890abcdef", "nullable" : true } } }, "Invoice_InvoiceChargeWSResponse" : { "type" : "object", "description" : "Response object for invoice charging operations.", "properties" : { "chargeSucceeded" : { "type" : "boolean", "description" : "Whether the invoice charge was successful", "example" : true, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMessage" : { "type" : "string", "description" : "Error message if the charge failed", "example" : "Insufficient funds", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "previouslyInitialized" : { "type" : "boolean", "description" : "Whether the invoice was previously initialized for charging", "example" : false, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Invoice_InvoiceDetailsV1WSResponse" : { "type" : "object", "description" : "Response object containing invoice details version 1.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invoice" : { "$ref" : "#/components/schemas/Invoice_InvoiceV1Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Invoice_InvoiceDetailsV2WSRequest" : { "type" : "object", "properties" : { "netsuiteInvoiceUuid" : { "type" : "string", "nullable" : true } } }, "Invoice_InvoiceDetailsV2WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invoice" : { "$ref" : "#/components/schemas/NetsuiteInvoiceDetails" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Invoice_InvoiceDetailsWSRequest" : { "type" : "object", "description" : "Request object for retrieving invoice details.", "properties" : { "invoiceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Invoice_InvoiceDetailsWSResponse" : { "type" : "object", "description" : "Response object containing invoice details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "invoice" : { "$ref" : "#/components/schemas/InvoiceType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Invoice_InvoiceV1LineItemType" : { "type" : "object", "description" : "Line item information for invoice version 1.", "properties" : { "description" : { "type" : "string", "description" : "Description of the product", "example" : "4K Ultra HD Security Camera with Night Vision", "nullable" : true }, "family" : { "type" : "string", "description" : "Product family category", "example" : "Cameras", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the product", "example" : "Security Camera", "nullable" : true }, "productCode" : { "type" : "string", "description" : "Product code for the line item", "example" : "CAM-001", "nullable" : true }, "quantity" : { "type" : "number", "format" : "float", "description" : "Quantity of the product", "example" : 2.0, "nullable" : true }, "subtotal" : { "type" : "number", "format" : "float", "description" : "Subtotal for this line item (quantity × unit price)", "example" : 199.98, "nullable" : true }, "unitPrice" : { "type" : "number", "format" : "float", "description" : "Unit price of the product", "example" : 99.99, "nullable" : true } } }, "Invoice_InvoiceV1Type" : { "type" : "object", "description" : "Invoice version 1 type containing comprehensive billing and line item information.", "properties" : { "billingContactEmail" : { "type" : "string", "description" : "Email address of the billing contact", "example" : "billing@company.com", "nullable" : true }, "billingContactMailingCity" : { "type" : "string", "description" : "Billing contact mailing city", "example" : "Los Angeles", "nullable" : true }, "billingContactMailingCountry" : { "type" : "string", "description" : "Billing contact mailing country", "example" : "United States", "nullable" : true }, "billingContactMailingPostalCode" : { "type" : "string", "description" : "Billing contact mailing postal code", "example" : "90210", "nullable" : true }, "billingContactMailingState" : { "type" : "string", "description" : "Billing contact mailing state", "example" : "CA", "nullable" : true }, "billingContactMailingStreet" : { "type" : "string", "description" : "Billing contact mailing street address", "example" : "456 Billing St", "nullable" : true }, "billingContactName" : { "type" : "string", "description" : "Name of the billing contact", "example" : "Jane Doe", "nullable" : true }, "companyName" : { "type" : "string", "description" : "Name of the company", "example" : "Acme Corporation", "nullable" : true }, "dueDate" : { "type" : "string", "description" : "Due date in YYYY-MM-DD format", "example" : "2024-02-14", "nullable" : true }, "grandTotal" : { "type" : "number", "format" : "float", "description" : "Grand total amount including tax and shipping", "example" : 225.98, "nullable" : true }, "invoiceDate" : { "type" : "string", "description" : "Invoice date in YYYY-MM-DD format", "example" : "2024-01-15", "nullable" : true }, "invoiceNumber" : { "type" : "string", "description" : "Invoice number", "example" : "INV-2024-001", "nullable" : true }, "lineItems" : { "type" : "array", "description" : "List of line items on the invoice", "items" : { "$ref" : "#/components/schemas/Invoice_InvoiceV1LineItemType" }, "nullable" : true }, "notes" : { "type" : "string", "description" : "Additional notes for the invoice", "example" : "Payment due within 30 days", "nullable" : true }, "partnerBillingCity" : { "type" : "string", "description" : "Partner billing city", "example" : "San Francisco", "nullable" : true }, "partnerBillingCountry" : { "type" : "string", "description" : "Partner billing country", "example" : "United States", "nullable" : true }, "partnerBillingPostalCode" : { "type" : "string", "description" : "Partner billing postal code", "example" : "94105", "nullable" : true }, "partnerBillingState" : { "type" : "string", "description" : "Partner billing state", "example" : "CA", "nullable" : true }, "partnerBillingStreet" : { "type" : "string", "description" : "Partner billing street address", "example" : "123 Business Ave", "nullable" : true }, "partnerName" : { "type" : "string", "description" : "Name of the partner", "example" : "Partner Solutions Inc", "nullable" : true }, "salespersonName" : { "type" : "string", "description" : "Name of the salesperson", "example" : "John Smith", "nullable" : true }, "shipping" : { "type" : "number", "format" : "float", "description" : "Shipping cost", "example" : 9.99, "nullable" : true }, "status" : { "type" : "string", "description" : "Status of the invoice", "example" : "Paid", "nullable" : true }, "subtotal" : { "type" : "number", "format" : "float", "description" : "Subtotal amount before tax and shipping", "example" : 199.99, "nullable" : true }, "tax" : { "type" : "number", "format" : "float", "description" : "Tax amount", "example" : 16.0, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "JakartaFamilyEnum" : { "type" : "string", "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "JakartaSameSiteEnum" : { "type" : "string", "enum" : [ "NONE", "LAX", "STRICT" ] }, "JavaTimeUnitEnum" : { "type" : "string", "description" : "Time granularity for the uptime report", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] }, "JsonNode" : { "type" : "object", "description" : "A WebAuthn credential auth response" }, "KeypadCommandEnum" : { "type" : "string", "description" : "Command being executed with the current keypad.", "enum" : [ "ALARM_RAISED", "ARM", "ARMED", "ARMING_COUNTDOWN", "CANCEL", "COUNTDOWN", "DISARM", "DISARMED", "DISARMING", "DISMISSING", "LOGS_REQUESTED", "PENDING_ARMED", "THREAT_DETECTED", "VERIFYING", "UNKNOWN" ] }, "KeypadConfigType" : { "type" : "object", "description" : "List of all registered keypads for the organization", "properties" : { "additionalFeaturesDisabled" : { "type" : "boolean", "nullable" : true }, "appVersionCode" : { "type" : "string", "nullable" : true }, "appVersionName" : { "type" : "string", "nullable" : true }, "armCountdownSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "buildingAdminPhoneNumber" : { "type" : "string", "nullable" : true }, "connectionState" : { "$ref" : "#/components/schemas/KeypadConnectionStateEnum" }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "ipAddress" : { "type" : "string", "nullable" : true }, "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationName" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "logoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "platform" : { "$ref" : "#/components/schemas/KeypadPlatformEnum" }, "qualifiedAddress" : { "$ref" : "#/components/schemas/QualifiedAddressType" }, "showCallBuildingAdmin" : { "type" : "boolean", "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "tz" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "KeypadConnectionStateEnum" : { "type" : "string", "enum" : [ "ONLINE", "OFFLINE" ] }, "KeypadPlatformEnum" : { "type" : "string", "description" : "The keypad platform (IOS or ANDROID)", "enum" : [ "ANDROID", "IOS" ] }, "Keypad_AuthenticatePinRequest" : { "type" : "object", "description" : "Request object for authenticating a keypad PIN.", "properties" : { "pin" : { "type" : "string", "description" : "PIN code to authenticate", "example" : "1234", "nullable" : true } } }, "Keypad_AuthenticatePinResponse" : { "type" : "object", "description" : "Response object for keypad PIN authentication.", "properties" : { "authenticated" : { "type" : "boolean", "description" : "Whether the PIN authentication was successful", "example" : true, "nullable" : true } } }, "Keypad_ClaimKeypadActivationTokenRequest" : { "type" : "object", "description" : "Request object for claiming a keypad activation token to connect a keypad to Rhombus services.", "properties" : { "activationToken" : { "type" : "string", "description" : "Activation token for claiming the keypad", "example" : "act_token_12345", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the keypad", "example" : "Main Entrance Keypad", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "Keypad_ClaimKeypadActivationTokenResponse" : { "type" : "object", "description" : "Response object for claiming a keypad activation token.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Keypad_GetCurrentKeypadWSRequest" : { "type" : "object", "description" : "Request object for getting the current keypad information." }, "Keypad_GetCurrentKeypadWSResponse" : { "type" : "object", "description" : "Response object containing current keypad configuration information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "keypad" : { "$ref" : "#/components/schemas/KeypadConfigType" }, "subLocationName" : { "type" : "string", "description" : "Name of the sub-location where the keypad is installed", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Keypad_GetKeypadsForLocationWSRequest" : { "type" : "object", "description" : "Request object for getting all registered keypads for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Keypad_GetKeypadsForLocationWSResponse" : { "type" : "object", "description" : "Response object containing all registered keypads for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "keypads" : { "type" : "array", "description" : "List of all registered keypads for the specified location", "items" : { "$ref" : "#/components/schemas/KeypadConfigType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Keypad_GetKeypadsForOrgWSRequest" : { "type" : "object", "description" : "Request object for getting all registered keypads for an organization." }, "Keypad_GetKeypadsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing all registered keypads for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "keypads" : { "type" : "array", "description" : "List of all registered keypads for the organization", "items" : { "$ref" : "#/components/schemas/KeypadConfigType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Keypad_KeypadCheckinWSRequest" : { "type" : "object", "description" : "Request object for keypad online/offline checkin processing.", "properties" : { "appVersionCode" : { "type" : "string", "description" : "build number --> 34", "nullable" : true }, "appVersionName" : { "type" : "string", "description" : "human readable --> 1.0.2", "nullable" : true }, "ipAddress" : { "type" : "string", "description" : "Local IP address of the keypad for discoverability", "nullable" : true }, "platform" : { "$ref" : "#/components/schemas/KeypadPlatformEnum" }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the keypad connection", "example" : -45, "nullable" : true } } }, "Keypad_KeypadCheckinWSResponse" : { "type" : "object", "description" : "Response object for keypad checkin operations." }, "Keypad_PublishKeypadCommandWSRequest" : { "type" : "object", "description" : "Request object for sending a STOMP containing a keypad command.", "properties" : { "command" : { "$ref" : "#/components/schemas/KeypadCommandEnum" }, "executeAtMs" : { "type" : "integer", "format" : "int64", "description" : "Epoch timestamp (ms) when to execute the command if applicable.", "nullable" : true } }, "required" : [ "command" ] }, "Keypad_UnregisterKeypadRequest" : { "type" : "object", "description" : "Request object for unregistering a keypad.", "properties" : { "keypadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Keypad_UnregisterKeypadResponse" : { "type" : "object", "description" : "Response object for unregistering a keypad.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Keypad_UpdateKeypadRequest" : { "type" : "object", "description" : "Request object for updating keypad settings and configuration.", "properties" : { "additionalFeaturesDisabled" : { "type" : "boolean", "nullable" : true }, "armCountdownSecs" : { "type" : "integer", "format" : "int32", "description" : "Arm countdown seconds for the keypad", "example" : 30, "nullable" : true }, "buildingAdminPhoneNumber" : { "type" : "string", "description" : "Phone number of the building administrator", "example" : "+1-555-123-4567", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the keypad is located", "example" : 1, "nullable" : true }, "keypadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the keypad location", "example" : 37.7749, "nullable" : true }, "locationName" : { "type" : "string", "description" : "Name of the location where the keypad is installed", "example" : "Main Building", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "logoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the keypad location", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the keypad", "example" : "Main Entrance Keypad", "nullable" : true }, "qualifiedAddress" : { "$ref" : "#/components/schemas/QualifiedAddressType" }, "showCallBuildingAdmin" : { "type" : "boolean", "description" : "Whether to show the call building admin option", "example" : true, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key has been updated", "example" : false, "nullable" : true }, "timeZoneId" : { "type" : "string", "description" : "Time zone ID for the keypad location", "example" : "America/Los_Angeles", "nullable" : true }, "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "videoWallUuidUpdated" : { "type" : "boolean", "description" : "Whether the video wall UUID has been updated", "example" : false, "nullable" : true } } }, "Keypad_UpdateKeypadResponse" : { "type" : "object", "description" : "Response object for updating keypad settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk" : { "type" : "object", "description" : "List of all registered kiosks for the organization", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "batteryLevel" : { "type" : "number", "format" : "float", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/ConnectionStatusEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "printerIP" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "KioskSelectiveUpdate" : { "type" : "object", "description" : "Selective update information for the kiosk", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "batteryLevel" : { "type" : "number", "format" : "float", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/ConnectionStatusEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "printerIP" : { "type" : "string", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_ClaimKioskActivationTokenRequest" : { "type" : "object", "description" : "Request object for claiming a kiosk activation token to connect a kiosk to Rhombus services.", "properties" : { "activationToken" : { "type" : "string", "description" : "Activation token for claiming the kiosk", "example" : "kiosk_token_12345", "nullable" : true }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the kiosk", "example" : "Lobby Guest Kiosk", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_ClaimKioskActivationTokenResponse" : { "type" : "object", "description" : "Response object for claiming a kiosk activation token.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_DeleteKioskWSRequest" : { "type" : "object", "description" : "Request object for deleting a kiosk.", "properties" : { "kioskUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_DeleteKioskWSResponse" : { "type" : "object", "description" : "Response object for deleting a kiosk.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_GetCurrentKioskWSRequest" : { "type" : "object", "description" : "Request object for getting the current kiosk information." }, "Kiosk_GetCurrentKioskWSResponse" : { "type" : "object", "description" : "Response object containing current kiosk information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "kiosk" : { "$ref" : "#/components/schemas/Kiosk_KioskWithInfo" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_GetKiosksForLocationWSRequest" : { "type" : "object", "description" : "Request object for getting all registered kiosks for a specific location.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_GetKiosksForLocationWSResponse" : { "type" : "object", "description" : "Response object containing all registered kiosks for a specific location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "kiosks" : { "type" : "array", "description" : "List of all registered kiosks for the specified location", "items" : { "$ref" : "#/components/schemas/Kiosk" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_GetKiosksForOrgWSRequest" : { "type" : "object", "description" : "Request object for getting all registered kiosks for an organization." }, "Kiosk_GetKiosksForOrgWSResponse" : { "type" : "object", "description" : "Response object containing all registered kiosks for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "kiosks" : { "type" : "array", "description" : "List of all registered kiosks for the organization", "items" : { "$ref" : "#/components/schemas/Kiosk" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_KioskCheckinWSRequest" : { "type" : "object", "description" : "Request object for kiosk heartbeat and online/offline processing.", "properties" : { "batteryLevel" : { "type" : "number", "format" : "float", "description" : "Battery level of the kiosk device", "example" : 0.85, "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the kiosk connection", "example" : -45, "nullable" : true } } }, "Kiosk_KioskCheckinWSResponse" : { "type" : "object", "description" : "Response object for kiosk heartbeat operations." }, "Kiosk_KioskWithInfo" : { "type" : "object", "description" : "Kiosk information with additional location details.", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "batteryLevel" : { "type" : "number", "format" : "float", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/ConnectionStatusEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "hostGroup" : { "$ref" : "#/components/schemas/OrgGroupType" }, "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lastUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "locationName" : { "type" : "string", "description" : "Name of the location where the kiosk is installed", "example" : "Main Lobby", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "printerIP" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_UnregisterKioskRequest" : { "type" : "object", "description" : "Request object for unregistering a kiosk.", "properties" : { "kioskUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Kiosk_UnregisterKioskResponse" : { "type" : "object", "description" : "Response object for unregistering a kiosk.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_UpdateKioskResponse" : { "type" : "object", "description" : "Response object for updating kiosk settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Kiosk_UpdateKioskSelectiveRequest" : { "type" : "object", "description" : "Request object for selectively updating kiosk settings.", "properties" : { "kioskUpdate" : { "$ref" : "#/components/schemas/KioskSelectiveUpdate" } } }, "KisiSettings" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "apiSecretKey" : { "type" : "string", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "defaultOptions" : { "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorToCameraMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "placeId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "placeToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationSettings" }, "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "KisiType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiSecretKey" : { "type" : "string", "nullable" : true }, "defaultOptions" : { "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "placeToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationSettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LEDModeEnum" : { "type" : "string", "enum" : [ "LED_OFF", "LED_RED_SOLID", "LED_GREEN_SOLID", "LED_ORANGE_SOLID", "LED_RED_BLINK", "LED_GREEN_BLINK", "LED_ORANGE_BLINK", "LED_NORMAL" ] }, "LabelIdentificationActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "alertLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "alertUnidentified" : { "type" : "boolean", "nullable" : true }, "allowedLabelSet" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "LastSeenInfo" : { "type" : "object", "properties" : { "lastSeenAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "LeakProbeType" : { "type" : "object", "properties" : { "adcMv" : { "type" : "number", "format" : "float", "nullable" : true }, "adcRaw" : { "type" : "integer", "format" : "int64", "nullable" : true }, "leakDetected" : { "type" : "boolean", "nullable" : true }, "moistDetected" : { "type" : "boolean", "nullable" : true }, "present" : { "type" : "boolean", "nullable" : true }, "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "LensRoleEnum" : { "type" : "string", "enum" : [ "VISIBLE", "THERMAL" ] }, "LicenseComparisonEntry" : { "type" : "object", "properties" : { "difference" : { "type" : "integer", "format" : "int32", "nullable" : true }, "existingCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "licenseType" : { "type" : "string", "nullable" : true }, "purchasedCount" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "LicenseEnum" : { "type" : "string", "enum" : [ "STARTER", "STANDARD", "ENTERPRISE", "LEGACY" ] }, "LicenseFeature" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "LicenseGroupStats" : { "type" : "object", "properties" : { "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "LicenseInvoiceSubItem" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "license" : { "$ref" : "#/components/schemas/LicenseEnum" }, "price" : { "type" : "number", "format" : "float", "nullable" : true } } }, "LicenseStateEnum" : { "type" : "string", "enum" : [ "CLAIMED", "RENEWED", "PENDING_RETURN", "NOT_RENEWED", "EXPIRED", "PERMANENTLY_EXPIRED" ] }, "LicenseStateStats" : { "type" : "object", "properties" : { "claimedCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the CLAIMED state.", "nullable" : true }, "expiredCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the EXPIRED state.", "nullable" : true }, "notRenewedCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the NOT_RENEWED state.", "nullable" : true }, "pendingReturnCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the PENDING_RETURN state.", "nullable" : true }, "permanentlyExpiredCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the PERMANENTLY_EXPIRED state.", "nullable" : true }, "renewedCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently in the RENEWED state.", "nullable" : true } } }, "LicenseToUnassignEmailStateEnum" : { "type" : "string", "enum" : [ "INITIAL_EMAIL_SUCCEEDED", "INITIAL_EMAIL_FAILED", "FIFTEEN_DAY_WARNING_EMAIL_SUCCEEDED", "FIFTEEN_DAY_WARNING_EMAIL_FAILED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_SUCCEEDED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_FAILED", "UNKNOWN" ] }, "LicenseUsageCatalogItem" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "addOnLicenseType" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" } } } ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "LicenseUsageStats" : { "type" : "object", "properties" : { "addOnLicenseStats" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AddOnLicenseStats" }, "nullable" : true }, "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "LicenseUsageType" : { "type" : "object", "description" : "List of licenses available for the client organization", "properties" : { "addOnLicenseType" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "additionalPerceptionFeatures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PerceptionTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "license" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "perceptionTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PerceptionTypeEnum" }, "nullable" : true, "uniqueItems" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignACUDoorLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning ACU door license.", "properties" : { "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignACUDoorLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning ACU door license.", "properties" : { "acuDoorLicense" : { "$ref" : "#/components/schemas/ACUDoorLicenseType" } } }, "License_AssignAlertMonitoringLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning alert monitoring license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignAlertMonitoringLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning alert monitoring license.", "properties" : { "alertMonitoringLicense" : { "$ref" : "#/components/schemas/AlertMonitoringLicenseType" } } }, "License_AssignDeviceLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning or unassigning a device license.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignDeviceLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning or unassigning a device license.", "properties" : { "deviceLicense" : { "$ref" : "#/components/schemas/DeviceLicenseType" } } }, "License_AssignGuestManagementLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning guest management license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignGuestManagementLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning guest management license.", "properties" : { "guestManagementLicense" : { "$ref" : "#/components/schemas/GuestManagementLicenseType" } } }, "License_AssignLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning an add-on license to a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_AssignLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning an add-on license to a device.", "properties" : { "licenseUsage" : { "$ref" : "#/components/schemas/LicenseUsageType" } } }, "License_AssignPaneLicenseWSRequest" : { "type" : "object", "description" : "Request object for assigning a PANE app license to a pane, or unassigning it.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "paneId" : { "type" : "string", "description" : "Id of the pane to assign the license to (the id in the pane's hostname, .pane.rhombus.com); null unassigns the license", "nullable" : true } } }, "License_AssignPaneLicenseWSResponse" : { "type" : "object", "description" : "Response object for assigning a PANE app license.", "properties" : { "paneLicense" : { "$ref" : "#/components/schemas/PaneLicenseType" } } }, "License_CalculateLicensesStatsForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for calculating license statistics for client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CalculateLicensesStatsForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing license statistics for client organization.", "properties" : { "orgLicenseStats" : { "$ref" : "#/components/schemas/OrgLicenseStats" } } }, "License_CalculateLicensesStatsForOrgWSRequest" : { "type" : "object", "description" : "Request object for calculating license statistics for organization.", "properties" : { "excludeTrialLicensesFromExpiredCount" : { "type" : "boolean", "description" : "Whether to exclude trial licenses from expired count", "example" : false, "nullable" : true } } }, "License_CalculateLicensesStatsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing license statistics for organization.", "properties" : { "orgLicenseStats" : { "$ref" : "#/components/schemas/OrgLicenseStats" } } }, "License_CreateACUDoorLicenseWSRequest" : { "type" : "object", "description" : "Request object for creating ACU door license.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CreateACUDoorLicenseWSResponse" : { "type" : "object", "description" : "Response object for creating ACU door license.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_CreateAlertMonitoringLicenseWSRequest" : { "type" : "object", "description" : "Request object for creating alert monitoring license.", "properties" : { "allowedDeviceCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CreateAlertMonitoringLicenseWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_CreateDeviceLicenseWSRequest" : { "type" : "object", "properties" : { "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CreateDeviceLicenseWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_CreateGuestManagementLicenseWSRequest" : { "type" : "object", "description" : "Request object for creating guest management license.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CreateGuestManagementLicenseWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_CreateLicenseWSRequest" : { "type" : "object", "properties" : { "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "license" : { "$ref" : "#/components/schemas/AddOnLicenseEnum" }, "licenseFamily" : { "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_CreateLicenseWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_CreatePaneLicenseWSRequest" : { "type" : "object", "description" : "Request object for creating a PANE app license in a client organization, optionally assigned.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "paneId" : { "type" : "string", "description" : "Optional pane id to assign the new license to immediately", "nullable" : true } } }, "License_CreatePaneLicenseWSResponse" : { "type" : "object", "description" : "Response object for creating a PANE app license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeleteAlertMonitoringLicenseWSRequest" : { "type" : "object", "description" : "Request object for deleting alert monitoring license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeleteAlertMonitoringLicenseWSResponse" : { "type" : "object", "description" : "Response object for deleting alert monitoring license.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_DeleteDeviceLicenseWSRequest" : { "type" : "object", "description" : "Request object for deleting an unassigned device license from an organization.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeleteDeviceLicenseWSResponse" : { "type" : "object", "description" : "Response object for deleting an unassigned device license from an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_DeleteGuestManagementLicenseWSRequest" : { "type" : "object", "description" : "Request object for deleting guest management license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeleteGuestManagementLicenseWSResponse" : { "type" : "object", "description" : "Response object for deleting guest management license.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_DeleteLicenseWSRequest" : { "type" : "object", "description" : "Request object for deleting an unassigned add-on license from an organization.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeleteLicenseWSResponse" : { "type" : "object", "description" : "Response object for deleting an unassigned add-on license from an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_DeletePaneLicenseWSRequest" : { "type" : "object", "description" : "Request object for deleting an unassigned PANE app license.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_DeletePaneLicenseWSResponse" : { "type" : "object", "description" : "Response object for deleting a PANE app license." }, "License_FindAssignedLicensesByLocationWSRequest" : { "type" : "object", "description" : "Request object for finding licenses assigned to a location.", "properties" : { "includeSubLocations" : { "type" : "boolean", "default" : true, "description" : "Whether to also include licenses assigned to sub locations of the location", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_FindAssignedLicensesByLocationWSResponse" : { "type" : "object", "description" : "Response object containing licenses assigned to a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenses" : { "type" : "array", "description" : "List of licenses assigned to the location", "items" : { "$ref" : "#/components/schemas/BaseLicenseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_FindLicensesByClaimKeyWSRequest" : { "type" : "object", "description" : "Request object for finding licenses by claim key.", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_FindLicensesByClaimKeyWSResponse" : { "type" : "object", "description" : "Response object containing licenses found by claim key.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenses" : { "type" : "array", "description" : "List of licenses found by claim key", "items" : { "$ref" : "#/components/schemas/BaseLicenseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetACUDoorLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting list of access controlled door licenses available for a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetACUDoorLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing list of access controlled door licenses available for a client organization.", "properties" : { "acuDoorLicenses" : { "type" : "array", "description" : "List of access controlled door licenses available for the client organization", "items" : { "$ref" : "#/components/schemas/ACUDoorLicenseType" }, "nullable" : true } } }, "License_GetACUDoorLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting list of access controlled door licenses available in organization." }, "License_GetACUDoorLicensesWSResponse" : { "type" : "object", "description" : "Response object containing list of access controlled door licenses available in organization.", "properties" : { "acuDoorLicenses" : { "type" : "array", "description" : "List of access controlled door licenses available in the organization", "items" : { "$ref" : "#/components/schemas/ACUDoorLicenseType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetAlertMonitoringLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting list of alert monitoring licenses available for a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetAlertMonitoringLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing list of alert monitoring licenses available for a client organization.", "properties" : { "alertMonitoringLicenses" : { "type" : "array", "description" : "List of alert monitoring licenses available for the client organization", "items" : { "$ref" : "#/components/schemas/AlertMonitoringLicenseType" }, "nullable" : true } } }, "License_GetAlertMonitoringLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting list of alert monitoring licenses available in organization." }, "License_GetAlertMonitoringLicensesWSResponse" : { "type" : "object", "description" : "Response object containing list of alert monitoring licenses available in organization.", "properties" : { "alertMonitoringLicenses" : { "type" : "array", "description" : "List of alert monitoring licenses available in the organization", "items" : { "$ref" : "#/components/schemas/AlertMonitoringLicenseType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetAssignablePanesWSRequest" : { "type" : "object", "description" : "Request object for getting the PANE apps this organization may assign licenses to." }, "License_GetAssignablePanesWSResponse" : { "type" : "object", "description" : "Response object containing the PANE apps this organization may assign licenses to.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "panes" : { "type" : "array", "description" : "PANE apps Rhombus has made available to the organization, with each one's tier", "items" : { "$ref" : "#/components/schemas/PaneType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetDeviceLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting list of device licenses available for a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetDeviceLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing list of device licenses available for a client organization.", "properties" : { "deviceLicenses" : { "type" : "array", "description" : "List of device licenses available for the client organization", "items" : { "$ref" : "#/components/schemas/DeviceLicenseType" }, "nullable" : true } } }, "License_GetDeviceLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting list of device licenses available in organization.", "properties" : { "optionalDeviceTypeFilter" : { "$ref" : "#/components/schemas/DeviceTypeEnum" } } }, "License_GetDeviceLicensesWSResponse" : { "type" : "object", "description" : "Response object containing list of device licenses available in organization.", "properties" : { "deviceLicenses" : { "type" : "array", "description" : "List of device licenses available in the organization", "items" : { "$ref" : "#/components/schemas/DeviceLicenseType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetGuestManagementLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting list of guest management licenses available for a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetGuestManagementLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing list of guest management licenses available for a client organization.", "properties" : { "guestManagementLicenses" : { "type" : "array", "description" : "List of guest management licenses available for the client organization", "items" : { "$ref" : "#/components/schemas/GuestManagementLicenseType" }, "nullable" : true } } }, "License_GetGuestManagementLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting list of guest management licenses available in organization." }, "License_GetGuestManagementLicensesWSResponse" : { "type" : "object", "description" : "Response object containing list of guest management licenses available in organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "guestManagementLicenses" : { "type" : "array", "description" : "List of guest management licenses available in the organization", "items" : { "$ref" : "#/components/schemas/GuestManagementLicenseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting list of licenses available for a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing list of licenses available for a client organization.", "properties" : { "licenses" : { "type" : "array", "description" : "List of licenses available for the client organization", "items" : { "$ref" : "#/components/schemas/LicenseUsageType" }, "nullable" : true } } }, "License_GetLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting list of add-on licenses available in organization.", "properties" : { "optionalDeviceTypeFilter" : { "$ref" : "#/components/schemas/DeviceTypeEnum" } } }, "License_GetLicensesWSResponse" : { "type" : "object", "description" : "Response object containing list of add-on licenses available in organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenses" : { "type" : "array", "description" : "List of add-on licenses available in the organization", "items" : { "$ref" : "#/components/schemas/LicenseUsageType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetPaneLicenseStatusWSRequest" : { "type" : "object", "description" : "Request object for checking whether the organization is licensed to use a PANE app.", "properties" : { "paneId" : { "type" : "string", "description" : "Id of the pane (the id in the pane's hostname, .pane.rhombus.com)", "nullable" : true } } }, "License_GetPaneLicenseStatusWSResponse" : { "type" : "object", "description" : "Whether the organization may use a PANE app right now, and why not if it may not.", "properties" : { "assignable" : { "type" : "boolean", "description" : "True when Rhombus has made the pane available to the organization, licensed or not", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "gracePeriodEndDate" : { "type" : "string", "format" : "date-time", "description" : "When the current entitlement lapses; absent for a license granted without a term", "nullable" : true }, "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "licensed" : { "type" : "boolean", "description" : "True when an active pane license is assigned to the pane", "nullable" : true }, "reason" : { "$ref" : "#/components/schemas/PaneLicenseStatusReasonEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetPaneLicensesForClientOrgWSRequest" : { "type" : "object", "description" : "Request object for a partner to list PANE app licenses in a client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_GetPaneLicensesForClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing the list of PANE app licenses in a client organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "paneLicenses" : { "type" : "array", "description" : "List of PANE app licenses in the client organization", "items" : { "$ref" : "#/components/schemas/PaneLicenseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_GetPaneLicensesWSRequest" : { "type" : "object", "description" : "Request object for getting the list of PANE app licenses in the organization." }, "License_GetPaneLicensesWSResponse" : { "type" : "object", "description" : "Response object containing the list of PANE app licenses in the organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "paneLicenses" : { "type" : "array", "description" : "List of PANE app licenses in the organization, assigned or not", "items" : { "$ref" : "#/components/schemas/PaneLicenseType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_catalog_FindCatalogItemsWSRequest" : { "type" : "object", "properties" : { "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "License_catalog_FindCatalogItemsWSResponse" : { "type" : "object", "properties" : { "catalogItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseCatalogItem" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_catalog_GetCatalogItemByProductCodeWSRequest" : { "type" : "object", "properties" : { "productCode" : { "type" : "string", "nullable" : true } } }, "License_catalog_GetCatalogItemByProductCodeWSResponse" : { "type" : "object", "properties" : { "catalogItem" : { "$ref" : "#/components/schemas/BaseCatalogItem" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_ClaimLicensesForClientOrgWSRequest" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_ClaimLicensesForClientOrgWSResponse" : { "type" : "object", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_ClaimLicensesFromSalesforceWSRequest" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_ClaimLicensesWSRequest" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true } } }, "License_claimkey_ClaimLicensesWSResponse" : { "type" : "object", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_CreateClaimKeyWSRequest" : { "type" : "object", "properties" : { "endDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "entry" : { "$ref" : "#/components/schemas/ClaimKeyEntry" }, "migratedRenewal" : { "type" : "boolean", "nullable" : true }, "requestId" : { "type" : "string", "nullable" : true }, "startDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "trial" : { "type" : "boolean", "nullable" : true } } }, "License_claimkey_CreateClaimKeyWSResponse" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_CreateRenewalClaimKeyWSRequest" : { "type" : "object", "properties" : { "endDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "entries" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ClaimKeyEntry" }, "nullable" : true }, "requestId" : { "type" : "string", "nullable" : true } } }, "License_claimkey_CreateRenewalClaimKeyWSResponse" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_FindClaimKeysByClientOrgWSRequest" : { "type" : "object", "properties" : { "claimKeySearchFilter" : { "$ref" : "#/components/schemas/ClaimKeySearchFilter" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_FindClaimKeysByClientOrgWSResponse" : { "type" : "object", "properties" : { "claimKeys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseClaimKey" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_FindClaimKeysByOrgWSRequest" : { "type" : "object", "properties" : { "claimKeySearchFilter" : { "$ref" : "#/components/schemas/ClaimKeySearchFilter" } } }, "License_claimkey_FindClaimKeysByOrgWSResponse" : { "type" : "object", "properties" : { "claimKeys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseClaimKey" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_GetClaimKeyByCodeForClientOrgWSRequest" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_GetClaimKeyByCodeForClientWSResponse" : { "type" : "object", "properties" : { "claimKey" : { "$ref" : "#/components/schemas/BaseClaimKey" } } }, "License_claimkey_GetClaimKeyByCodeWSRequest" : { "type" : "object", "properties" : { "claimCode" : { "type" : "string", "nullable" : true } } }, "License_claimkey_GetClaimKeyByCodeWSResponse" : { "type" : "object", "properties" : { "claimKey" : { "$ref" : "#/components/schemas/BaseClaimKey" } } }, "License_claimkey_GetClaimKeyWSRequest" : { "type" : "object", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_GetClaimKeyWSResponse" : { "type" : "object", "properties" : { "claimKey" : { "$ref" : "#/components/schemas/BaseClaimKey" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_GetClaimKeysForPartnerOrgWSRequest" : { "type" : "object", "description" : "Request object for getting the claim keys belonging to the authenticated partner organization." }, "License_claimkey_GetClaimKeysForPartnerOrgWSResponse" : { "type" : "object", "description" : "Response object containing the claim keys belonging to the authenticated partner organization.", "properties" : { "claimKeys" : { "type" : "array", "description" : "List of claim keys belonging to the partner organization", "items" : { "$ref" : "#/components/schemas/PartnerOrgClaimKey" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "License_claimkey_ReturnClaimKeyProductQuantitiesWSRequest" : { "type" : "object", "properties" : { "productQuantities" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "License_claimkey_ReturnClaimKeyProductQuantitiesWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "LineItems" : { "type" : "object", "properties" : { "description" : { "type" : "string", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productcode" : { "type" : "string", "nullable" : true }, "quantity" : { "type" : "number", "nullable" : true }, "subtotal" : { "type" : "number", "nullable" : true }, "unitPrice" : { "type" : "number", "nullable" : true }, "unitprice" : { "type" : "number", "nullable" : true, "writeOnly" : true } } }, "Link" : { "type" : "object", "nullable" : true, "properties" : { "params" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "rel" : { "type" : "string", "nullable" : true }, "rels" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "title" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "nullable" : true }, "uri" : { "type" : "string", "format" : "uri", "nullable" : true }, "uriBuilder" : { "$ref" : "#/components/schemas/UriBuilder" } } }, "LiveNotificationActionRecordType" : { "type" : "object", "properties" : { "status" : { "$ref" : "#/components/schemas/LiveNotificationActionStatusEnum" } } }, "LiveNotificationActionStatusEnum" : { "type" : "string", "enum" : [ "SUCCESS", "ERROR", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] }, "LocalDateTimeIntervalType" : { "type" : "object", "properties" : { "localEndDateTime" : { "type" : "string", "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", "nullable" : true }, "localStartDateTime" : { "type" : "string", "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", "nullable" : true } }, "required" : [ "localEndDateTime", "localStartDateTime" ] }, "LocalInterval" : { "type" : "object", "description" : "List of intervals each specifying door state during date range. List must contain at least one element", "properties" : { "localEndDateTime" : { "type" : "string", "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", "nullable" : true }, "localStartDateTime" : { "type" : "string", "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } }, "required" : [ "localEndDateTime", "localStartDateTime", "state" ] }, "LocationALMConfig" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "acceptedTermsOfService" : { "type" : "boolean", "description" : "Indication of whether the org accepted the terms of service for alarm monitoring at this location.\n", "nullable" : true }, "defaultEmergencyContact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "mode" : { "$ref" : "#/components/schemas/MonitoringModeEnum" }, "talkdownEnabled" : { "type" : "boolean", "description" : "Indication of whether talk-down is enabled for this location.", "nullable" : true } } } ], "nullable" : true, "properties" : { "deleted" : { "type" : "boolean", "description" : "Indication of whether this config was deleted.", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/TypeEnum" }, "versionInfo" : { "$ref" : "#/components/schemas/ALMModificationMetadata" }, "zoneId" : { "type" : "string", "nullable" : true } }, "required" : [ "locationUuid" ] }, "LocationAccessControlGuestPass" : { "type" : "object", "discriminator" : { "propertyName" : "principalType" }, "oneOf" : [ { "$ref" : "#/components/schemas/PlainLocationAccessControlGuestPass" }, { "$ref" : "#/components/schemas/RhombusGuestLocationAccessControlGuestPass" } ], "properties" : { "accessPeriods" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" }, "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "lifecycle" : { "$ref" : "#/components/schemas/LocationGuestPassLifecycleEnum" }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "note" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "passStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "principalType" : { "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" }, "reconciledAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "reconciledVersion" : { "type" : "integer", "format" : "int64", "nullable" : true }, "sortKey" : { "type" : "string", "nullable" : true, "readOnly" : true }, "stampVersion" : { "type" : "integer", "format" : "int64", "nullable" : true }, "stampedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationAccessGrantType" : { "type" : "object", "description" : "The access grant to update", "properties" : { "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "doorLabelIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationGuestPassUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/AccessGrantModeEnum" }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sortKey" : { "type" : "string", "nullable" : true, "readOnly" : true }, "storedInS3" : { "type" : "boolean", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationAccessRevocationType" : { "type" : "object", "description" : "The access revocation to update", "properties" : { "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "doorLabelIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sortKey" : { "type" : "string", "nullable" : true, "readOnly" : true }, "storedInS3" : { "type" : "boolean", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationFirstInSettings" : { "type" : "object", "description" : "The updated location first-in settings.", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "doorAuthFirstInOutOfSync" : { "type" : "boolean", "nullable" : true }, "doorAuthFirstInState" : { "$ref" : "#/components/schemas/FirstInState" }, "doorAuthRequirementEnabled" : { "type" : "boolean", "nullable" : true }, "doorScheduleFirstInOutOfSync" : { "type" : "boolean", "nullable" : true }, "doorScheduleFirstInState" : { "$ref" : "#/components/schemas/FirstInState" }, "doorScheduleRequirementEnabled" : { "type" : "boolean", "nullable" : true }, "doorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "elevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "resets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BaseFirstInReset" }, "nullable" : true }, "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "LocationFunctionalityEnum" : { "type" : "string", "description" : "Location functionality enum for exposing to OpenAPI component schemas", "enum" : [ "ACCESS_CONDITIONS", "ACCESS_SCHEDULES", "CCS_VISIBLE", "DOOR_SETTINGS", "FIRST_IN_SETTINGS", "GUEST_PASSES", "HARDWARE_CONFIG", "LOCKDOWN_MANAGEMENT", "REMOTE_UNLOCK", "UNKNOWN" ] }, "LocationGuestPassAccessPeriod" : { "type" : "object", "properties" : { "absoluteIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "intervalSource" : { "$ref" : "#/components/schemas/GuestPassIntervalSourceEnum" }, "localIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocalDateTimeIntervalType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationGuestPassAccessPeriodUpdate" : { "type" : "object", "properties" : { "absoluteIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "delete" : { "type" : "boolean", "nullable" : true }, "intervalSource" : { "$ref" : "#/components/schemas/GuestPassIntervalSourceEnum" }, "localIntervals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocalDateTimeIntervalType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationGuestPassLifecycleEnum" : { "type" : "string", "enum" : [ "ACTIVE", "SUSPENDED", "EXPIRED", "ARCHIVED" ] }, "LocationGuestPassPrincipalTypeEnum" : { "type" : "string", "enum" : [ "PLAIN", "RHOMBUS_GUEST_MANAGEMENT" ] }, "LocationLockdownActivatedRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "LocationLockdownDeactivatedRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, "LocationLockdownPlanType" : { "type" : "object", "description" : "The updated location lockdown plan.", "properties" : { "activationPlan" : { "$ref" : "#/components/schemas/LockdownActivationPlanType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deactivationPlan" : { "$ref" : "#/components/schemas/LockdownDeactivationPlanType" }, "defaultLockdownState" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "doorLockdownStateMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "physicalAccess" : { "$ref" : "#/components/schemas/LockdownPhysicalAccessType" }, "scopeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "testPlan" : { "$ref" : "#/components/schemas/LockdownTestPlanType" }, "type" : { "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LocationLockdownStateEnumType" : { "type" : "string", "enum" : [ "STANDARD_SECURITY", "LOCKED_DOWN" ] }, "LocationLockdownStateType" : { "type" : "object", "description" : "The lockdown state for the location.", "properties" : { "activeLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true, "uniqueItems" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/LocationLockdownStateEnumType" }, "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "LocationSettings" : { "type" : "object", "nullable" : true, "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "printBadge" : { "type" : "boolean", "nullable" : true } } }, "LocationType" : { "type" : "object", "description" : "Location information to update", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "description" : "Description of this location", "nullable" : true }, "floorPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FloorPlanType" }, "nullable" : true }, "labels" : { "type" : "array", "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "items" : { "type" : "string", "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of this location", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "subLocations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationType" }, "nullable" : true, "uniqueItems" : true }, "tz" : { "type" : "string", "description" : "Timezone for this location", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Location_AddLocationLabelWSRequest" : { "type" : "object", "description" : "Request object for adding a label to a location.", "properties" : { "label" : { "type" : "string", "description" : "Label to add to the location", "nullable" : true }, "locationIdentifier" : { "type" : "string", "description" : "Location identifier (name or ID)", "nullable" : true } } }, "Location_AddLocationLabelWSResponse" : { "type" : "object", "description" : "Response object for adding a label to a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_CreateLocationWSRequest" : { "type" : "object", "description" : "Request object for creating a location.", "properties" : { "location" : { "$ref" : "#/components/schemas/LocationType" }, "parentLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Location_CreateLocationWSResponse" : { "type" : "object", "description" : "Response object for creating a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_DeleteLocationWSRequest" : { "type" : "object", "description" : "Request object for removing a location.", "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Location_DeleteLocationWSResponse" : { "type" : "object", "description" : "Response object for removing a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_FloorPlanWallsWSType" : { "type" : "object", "description" : "Walls detected in a floor plan image, as axis-aligned rectangles in image pixels.", "properties" : { "imageHeight" : { "type" : "integer", "format" : "int32", "description" : "Height in pixels of the image the walls were detected in", "nullable" : true }, "imageWidth" : { "type" : "integer", "format" : "int32", "description" : "Width in pixels of the image the walls were detected in", "nullable" : true }, "model" : { "type" : "string", "description" : "Model that detected the walls", "nullable" : true }, "wallRects" : { "type" : "array", "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", "items" : { "type" : "array", "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", "items" : { "type" : "integer", "format" : "int32", "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", "nullable" : true }, "nullable" : true }, "nullable" : true } } }, "Location_GeoCodeWSRequest" : { "type" : "object", "description" : "Request object for getting the latitude and longitude of an address.", "properties" : { "address" : { "type" : "string", "description" : "Address to geocode", "example" : "1600 Pennsylvania Avenue NW, Washington, DC", "nullable" : true } } }, "Location_GeoCodeWSResponse" : { "type" : "object", "description" : "Response object containing the latitude and longitude of an address.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the address", "example" : 38.8977, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the address", "example" : -77.0365, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetFloorPlanWallsWSRequest" : { "type" : "object", "description" : "Request object for getting the detected walls of a floor plan image.", "properties" : { "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "floorPlanUuid" ] }, "Location_GetFloorPlanWallsWSResponse" : { "type" : "object", "description" : "Response object containing the detected walls of a floor plan image.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "walls" : { "$ref" : "#/components/schemas/Location_FloorPlanWallsWSType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationLabelsForOrgWSRequest" : { "type" : "object", "description" : "Request object for getting all location labels for an organization." }, "Location_GetLocationLabelsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing all location labels for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationLabels" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of location name or location id to label set", "items" : { "type" : "string", "description" : "Map of location name or location id to label set", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "description" : "Map of location name or location id to label set", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationWSRequest" : { "type" : "object", "description" : "Request object for getting location by ID.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsRequired" : { "type" : "boolean", "description" : "Whether sub-locations are required in the response", "example" : false, "nullable" : true } }, "required" : [ "locationUuid" ] }, "Location_GetLocationWSResponse" : { "type" : "object", "description" : "Response object containing location information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "location" : { "$ref" : "#/components/schemas/LocationType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationsByGeoRequest" : { "type" : "object", "description" : "Request object for getting list of locations given latitude and longitude.", "properties" : { "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate", "example" : 37.7749, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate", "example" : -122.4194, "nullable" : true } } }, "Location_GetLocationsByGeoResponse" : { "type" : "object", "description" : "Response object containing list of locations given latitude and longitude.", "properties" : { "locations" : { "type" : "array", "description" : "Collection of locations found at the specified coordinates", "items" : { "$ref" : "#/components/schemas/LocationType" }, "nullable" : true } } }, "Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" : { "type" : "object", "description" : "Request object for getting nested locations by subLocationHierarchyKey.", "properties" : { "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" : { "type" : "object", "description" : "Response object containing nested locations by subLocationHierarchyKey.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "location" : { "$ref" : "#/components/schemas/LocationType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationsV2WSRequest" : { "type" : "object", "description" : "Request object for getting list of locations in organization with pagination support.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nameBeginsWithFilter" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationsV2WSResponse" : { "type" : "object", "description" : "Response object containing list of locations in organization with pagination support.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "locations" : { "type" : "array", "description" : "List of locations in the organization", "items" : { "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_GetLocationsWSRequest" : { "type" : "object", "description" : "Request object for getting list of locations in organization.", "properties" : { "subLocationsIncluded" : { "type" : "boolean", "description" : "Whether to include sub-locations in the response", "example" : false, "nullable" : true } } }, "Location_GetLocationsWSResponse" : { "type" : "object", "description" : "Response object containing list of locations in organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locations" : { "type" : "array", "description" : "List of locations in the organization", "items" : { "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_QualifiedAddressTypeWithValidation" : { "type" : "object", "description" : "Qualified address with validation information", "properties" : { "addressComplete" : { "type" : "boolean", "nullable" : true }, "addressLine2" : { "type" : "string", "description" : "apt, suite, or unit", "nullable" : true }, "addressline1" : { "type" : "string", "description" : "street address", "nullable" : true }, "administrativeArea" : { "type" : "string", "description" : "state", "nullable" : true }, "locality" : { "type" : "string", "description" : "city", "nullable" : true }, "postalCode" : { "type" : "string", "description" : "zip code", "nullable" : true }, "regionCode" : { "type" : "string", "description" : "country", "nullable" : true }, "validatedAddressline1" : { "type" : "boolean", "nullable" : true }, "validatedAdminestrativeArea" : { "type" : "boolean", "nullable" : true }, "validatedLocality" : { "type" : "boolean", "nullable" : true }, "validatedPostalCode" : { "type" : "boolean", "nullable" : true }, "validatedRegionCode" : { "type" : "boolean", "nullable" : true }, "validatedSubpremise" : { "type" : "boolean", "nullable" : true } } }, "Location_RefreshFloorPlanWallsWSRequest" : { "type" : "object", "description" : "Request object for re-detecting and storing the walls of a floor plan image.", "properties" : { "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "floorPlanUuid" ] }, "Location_RefreshFloorPlanWallsWSResponse" : { "type" : "object", "description" : "Response object containing the newly detected walls of a floor plan image.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "walls" : { "$ref" : "#/components/schemas/Location_FloorPlanWallsWSType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_RemoveLocationLabelWSRequest" : { "type" : "object", "description" : "Request object for removing a label from a location.", "properties" : { "label" : { "type" : "string", "description" : "Label to remove from the location", "nullable" : true }, "locationIdentifier" : { "type" : "string", "description" : "Location identifier (name or ID)", "nullable" : true } } }, "Location_RemoveLocationLabelWSResponse" : { "type" : "object", "description" : "Response object for removing a label from a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_SelectiveUpdateLocationWSRequest" : { "type" : "object", "description" : "Request object for selectively updating a location.", "properties" : { "address1" : { "type" : "string", "description" : "First line of the address", "nullable" : true }, "address2" : { "type" : "string", "description" : "Second line of the address", "nullable" : true }, "countryCode" : { "type" : "string", "description" : "Country code of the location", "nullable" : true }, "floorPlans" : { "type" : "array", "description" : "Floor plans for the location", "items" : { "$ref" : "#/components/schemas/FloorPlanType" }, "nullable" : true }, "labels" : { "type" : "array", "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "items" : { "type" : "string", "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the location", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the location", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of this location", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "postalCode" : { "type" : "string", "description" : "Postal code of the location", "nullable" : true }, "timezoneId" : { "type" : "string", "description" : "Timezone identifier, e.g. America/Los_Angeles, EST, GMT+0, etc.", "nullable" : true }, "tz" : { "type" : "object", "description" : "Use timezoneId field instead", "nullable" : true, "properties" : { "displayName" : { "type" : "string", "nullable" : true }, "dstsavings" : { "type" : "integer", "format" : "int32", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "rawOffset" : { "type" : "integer", "format" : "int32", "nullable" : true } } } }, "required" : [ "locationUuid" ] }, "Location_SelectiveUpdateLocationWSResponse" : { "type" : "object", "description" : "Response object for selectively updating a location.", "nullable" : true, "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_UpdateLocationWSRequest" : { "type" : "object", "description" : "Request object for updating a location. NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation.", "properties" : { "location" : { "$ref" : "#/components/schemas/LocationType" } } }, "Location_UpdateLocationWSResponse" : { "type" : "object", "description" : "Response object for updating a location.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_ValidateAndUpdateLocationAddressWSRequest" : { "type" : "object", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "administrativeArea" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "locality" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "overrideAllValidation" : { "type" : "boolean", "nullable" : true }, "overrideMissingSubPremise" : { "type" : "boolean", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true } } }, "Location_ValidateAndUpdateLocationAddressWSResponse" : { "type" : "object", "description" : "Response object for validating and updating a location address for Alarm Monitoring.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "qualifiedAddress" : { "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_ValidateLocationAddressV2WSRequest" : { "type" : "object", "properties" : { "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "administrativeArea" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "locality" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true } } }, "Location_ValidateLocationAddressV2WSResponse" : { "type" : "object", "description" : "Response object for validating and updating a location address for Alarm Monitoring.", "properties" : { "acceptable" : { "type" : "boolean", "nullable" : true }, "acceptableExceptingSubPremise" : { "type" : "boolean", "nullable" : true }, "acceptableIfOverridden" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "hasChangedElements" : { "type" : "boolean", "nullable" : true, "writeOnly" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "qualifiedAddress" : { "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Location_ValidateLocationWSRequest" : { "type" : "object", "description" : "Request object for validating a location address for Alarm Monitoring.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Location_ValidateLocationWSResponse" : { "type" : "object", "description" : "Response object for validating a location address for Alarm Monitoring.", "properties" : { "acceptable" : { "type" : "boolean", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "qualifiedAddress" : { "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "LockdownActivatedStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "activatedLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, "activeLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, "deactivatedLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" }, "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, "LockdownActivationPlanType" : { "type" : "object", "properties" : { "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "rhombusKeyNotificationMessage" : { "type" : "string", "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "LockdownActivationResultEnumType" : { "type" : "string", "description" : "The result of the lockdown activation operation.", "enum" : [ "SUCCESS", "INVALID_LOCKDOWN_PLANS", "OPTIMISTIC_CONCURRENCY" ] }, "LockdownDeactivatedStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "deactivatedLockdownPlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "followingTestPlan" : { "type" : "boolean", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originator" : { "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" }, "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, "LockdownDeactivationPlanType" : { "type" : "object", "properties" : { "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "rhombusKeyNotificationMessage" : { "type" : "string", "nullable" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "LockdownDeactivationResultEnumType" : { "type" : "string", "description" : "The result of the lockdown deactivation operation.", "enum" : [ "SUCCESS", "OPTIMISTIC_CONCURRENCY" ] }, "LockdownEventOriginatorEnumType" : { "type" : "string", "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "UNKNOWN" ] }, "LockdownPhysicalAccessType" : { "type" : "object", "properties" : { "groupUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "LockdownPlanReference" : { "type" : "object", "properties" : { "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scope" : { "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, "scopeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LockdownPlanScopeEnumType" : { "type" : "string", "enum" : [ "ORG_LOCKDOWN", "LOCATION_LOCKDOWN" ] }, "LockdownStateEventEnumType" : { "type" : "string", "enum" : [ "LOCKDOWN_ACTIVATED", "LOCKDOWN_DEACTIVATED" ] }, "LockdownTestPlanType" : { "type" : "object", "properties" : { "doorStateOverrideEnabled" : { "type" : "boolean", "nullable" : true }, "userAccessOverrideEnabled" : { "type" : "boolean", "nullable" : true } } }, "LockdownType" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "nullable" : true }, "isActive" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "LocomotionMovementEnum" : { "type" : "string", "description" : "Filter events by locomotion movement type", "enum" : [ "ARRIVAL", "DEPARTURE", "MOVED_SIGNIFICANTLY", "UNKNOWN" ] }, "Logistics_GetRMAsWSRequest" : { "type" : "object", "description" : "Request object for getting RMAs (Return Merchandise Authorizations)." }, "Logistics_GetRMAsWSResponse" : { "type" : "object", "description" : "Response object containing RMAs (Return Merchandise Authorizations).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rmaList" : { "type" : "array", "description" : "List of RMAs (Return Merchandise Authorizations)", "items" : { "$ref" : "#/components/schemas/RMAType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Logistics_GetShipmentsWSRequest" : { "type" : "object", "description" : "Request object for getting shipments within a time range.", "properties" : { "endTimeSec" : { "type" : "integer", "format" : "int64", "description" : "End time in seconds (Unix timestamp)", "example" : 1641081600, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time in seconds (Unix timestamp)", "example" : 1640995200, "nullable" : true } } }, "Logistics_GetShipmentsWSResponse" : { "type" : "object", "description" : "Response object containing shipments within the specified time range.", "properties" : { "customerShipmentList" : { "type" : "array", "description" : "List of customer shipments within the specified time range", "items" : { "$ref" : "#/components/schemas/CustomerShipmentType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "LoiterActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "loiterDurationSecThreshold" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "LumeoSettings" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "LumeoType" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ManagedClientPolicyType" : { "type" : "object", "properties" : { "clientSuperAdminAssignable" : { "type" : "boolean", "nullable" : true } } }, "ManualAccessStateChangeEnum" : { "type" : "string", "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] }, "ManualAccessStateChangeEnum_Minimal" : { "type" : "string", "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] }, "ManualAlarmPolicy" : { "type" : "object", "description" : "Threat-detection policy that applies when this zone is in manual monitoring mode.", "nullable" : true, "properties" : { "rules" : { "type" : "array", "description" : "The rules governing threat detection and subsequent actions.", "items" : { "$ref" : "#/components/schemas/AlarmRule" }, "nullable" : true }, "type" : { "$ref" : "#/components/schemas/MonitoringModeEnum" }, "verifiedThreatSiren" : { "$ref" : "#/components/schemas/AMSirenSettingsType" } }, "required" : [ "rules" ] }, "Maps_GenerateMapUrlWSRequest" : { "type" : "object", "description" : "Request object for generating a map URL.", "properties" : { "baseUrl" : { "type" : "string", "description" : "Base URL for the map", "example" : "https://maps.google.com/maps?q=", "nullable" : true } } }, "Maps_GenerateMapUrlWSResponse" : { "type" : "object", "description" : "Response object containing the generated map URL.", "properties" : { "signedUrl" : { "type" : "string", "description" : "Signed URL for the map", "example" : "https://maps.google.com/maps?q=123+Main+St&key=abc123", "nullable" : true } } }, "MattermostSettings" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "MediaRegionHistoryEntryType" : { "type" : "object", "properties" : { "region" : { "type" : "string", "nullable" : true }, "untilMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "MediaType" : { "type" : "object", "properties" : { "charset" : { "type" : "object", "nullable" : true, "properties" : { "registered" : { "type" : "boolean", "nullable" : true } } }, "concrete" : { "type" : "boolean", "nullable" : true }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "qualityValue" : { "type" : "number", "format" : "double", "nullable" : true }, "subtype" : { "type" : "string", "nullable" : true }, "subtypeSuffix" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "nullable" : true }, "wildcardSubtype" : { "type" : "boolean", "nullable" : true }, "wildcardType" : { "type" : "boolean", "nullable" : true } } }, "Mediadevice_GetBulkMediaDeviceDetailsWSRequest" : { "type" : "object", "description" : "Request object for getting media information of any video-supporting media device.", "properties" : { "devices" : { "type" : "array", "description" : "Set of device facet UUIDs to get media details for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "Mediadevice_GetBulkMediaDeviceDetailsWSResponse" : { "type" : "object", "description" : "Response object containing media information for video-supporting media devices.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "mediaDeviceDetails" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Mediadevice_MediaDeviceDetailsType" }, "description" : "Map of device facet UUIDs to their media device details", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Mediadevice_MediaDeviceDetailsType" : { "type" : "object", "description" : "Detailed information about a media device including streaming URLs and device characteristics.", "properties" : { "audioGateways" : { "type" : "array", "description" : "List of audio gateway UUIDs associated with the device", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "deviceFacetUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanCheckUrls" : { "type" : "array", "description" : "URLs to check if the device is available on LAN", "items" : { "type" : "string", "description" : "URLs to check if the device is available on LAN", "nullable" : true }, "nullable" : true }, "lanLiveH264Uris" : { "type" : "array", "description" : "LAN live H264 streaming URIs", "items" : { "type" : "string", "description" : "LAN live H264 streaming URIs", "nullable" : true }, "nullable" : true }, "lanLiveM3u8Uris" : { "type" : "array", "description" : "LAN live M3U8 streaming URIs", "items" : { "type" : "string", "description" : "LAN live M3U8 streaming URIs", "nullable" : true }, "nullable" : true }, "lanLiveMpdUris" : { "type" : "array", "description" : "LAN live MPD streaming URIs", "items" : { "type" : "string", "description" : "LAN live MPD streaming URIs", "nullable" : true }, "nullable" : true }, "lanVodM3u8UrisTemplates" : { "type" : "array", "description" : "LAN VOD M3U8 URI templates", "items" : { "type" : "string", "description" : "LAN VOD M3U8 URI templates", "nullable" : true }, "nullable" : true }, "lanVodMpdUrisTemplates" : { "type" : "array", "description" : "LAN VOD MPD URI templates", "items" : { "type" : "string", "description" : "LAN VOD MPD URI templates", "nullable" : true }, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the device", "example" : "Front Door Camera", "nullable" : true }, "region" : { "type" : "string", "description" : "Region where the device is located", "example" : "us-west-2", "nullable" : true }, "timezone" : { "type" : "object", "description" : "Timezone of the device", "nullable" : true, "properties" : { "displayName" : { "type" : "string", "nullable" : true }, "dstsavings" : { "type" : "integer", "format" : "int32", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "rawOffset" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "uri" : { "type" : "string", "description" : "URI of the device", "example" : "rtsp://device.local/stream", "nullable" : true }, "wanLiveH264Uri" : { "type" : "string", "description" : "WAN live H264 streaming URI", "example" : "https://stream.rhombussystems.com/live/device123.h264", "nullable" : true }, "wanLiveM3u8Uri" : { "type" : "string", "description" : "WAN live M3U8 streaming URI", "example" : "https://stream.rhombussystems.com/live/device123.m3u8", "nullable" : true }, "wanLiveMpdUri" : { "type" : "string", "description" : "WAN live MPD streaming URI", "example" : "https://stream.rhombussystems.com/live/device123.mpd", "nullable" : true }, "wanVodH264UriTemplate" : { "type" : "string", "description" : "WAN VOD H264 URI template", "example" : "https://vod.rhombussystems.com/{timestamp}/device123.h264", "nullable" : true }, "wanVodM3u8UriTemplate" : { "type" : "string", "description" : "WAN VOD M3U8 URI template", "example" : "https://vod.rhombussystems.com/{timestamp}/device123.m3u8", "nullable" : true }, "wanVodMpdUriTemplate" : { "type" : "string", "description" : "WAN VOD MPD URI template", "example" : "https://vod.rhombussystems.com/{timestamp}/device123.mpd", "nullable" : true } } }, "MessageBodyWorkers" : { "type" : "object", "nullable" : true }, "MetaDataLocationType" : { "type" : "object", "properties" : { "region" : { "type" : "string", "nullable" : true } } }, "Metric_LogEventWSRequest" : { "type" : "object", "description" : "Request object for logging events.", "properties" : { "logMap" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Map containing log event data", "nullable" : true }, "description" : "Map containing log event data", "nullable" : true } } }, "Metric_LogEventWSResponse" : { "type" : "object", "description" : "Response object for logging events.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Metric_ReportErrorWSRequest" : { "type" : "object", "description" : "Request object for reporting errors.", "properties" : { "errorMap" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Map containing error information", "nullable" : true }, "description" : "Map containing error information", "nullable" : true } } }, "Metric_ReportErrorWSResponse" : { "type" : "object", "description" : "Response object for reporting errors.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Metric_ReportVideoPlaybackStatsWSRequest" : { "type" : "object", "description" : "Request object for reporting browser video playback stats.", "properties" : { "pageExit" : { "type" : "boolean", "description" : "True when the browser sends the request as the page closes or goes hidden. The server then admits no session to Amplitude.", "nullable" : true }, "records" : { "type" : "array", "description" : "The records to report: 1 to 25. The server drops a record that is not valid and keeps the others.", "items" : { "$ref" : "#/components/schemas/Metric_VideoPlaybackStatsRecordWS" }, "nullable" : true } }, "required" : [ "records" ] }, "Metric_ReportVideoPlaybackStatsWSResponse" : { "type" : "object", "description" : "Response object for reporting browser video playback stats. It also tells the browser how to collect stats.", "properties" : { "amplitudeSessionIds" : { "type" : "array", "description" : "The playbackSessionIds of final records that the browser can also send to Amplitude. Empty when the server admits none.", "items" : { "type" : "string", "description" : "The playbackSessionIds of final records that the browser can also send to Amplitude. Empty when the server admits none.", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "description" : "False when the server does not collect playback stats. The browser must then stop sending them.", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flushSeconds" : { "type" : "integer", "format" : "int32", "description" : "How often, in seconds, the browser flushes the stats of an open playback session.", "example" : 300, "nullable" : true }, "sampleRate" : { "type" : "number", "format" : "double", "description" : "The fraction of users (0 to 1) that the browser samples for playback stats. Only present when an operator sets it. When it is not present, the browser uses its own default.", "example" : 0.25, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } }, "required" : [ "amplitudeSessionIds", "enabled", "flushSeconds" ] }, "Metric_VideoPlaybackStatsRecordWS" : { "type" : "object", "description" : "One flush of the playback stats of one video playback session in the browser.", "properties" : { "cameraUuid" : { "type" : "string", "description" : "The camera that the session played, or null. 64 characters maximum.", "nullable" : true }, "context" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Descriptive dimensions (browser, os, video type and more). 60 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a string (the server truncates it to 256 characters), a finite number or a boolean. The server drops other entries. \"sampled\": false marks a user that the browser did not sample: the server stores the record but never admits it to Amplitude.", "nullable" : true }, "description" : "Descriptive dimensions (browser, os, video type and more). 60 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a string (the server truncates it to 256 characters), a finite number or a boolean. The server drops other entries. \"sampled\": false marks a user that the browser did not sample: the server stores the record but never admits it to Amplitude.", "nullable" : true }, "endTs" : { "type" : "integer", "format" : "int64", "description" : "End of the period that this flush covers, in epoch milliseconds. Must not be before startTs or more than 24 hours after it.", "example" : 1790000300000, "nullable" : true }, "final" : { "type" : "boolean", "description" : "True for the last flush of the playback session.", "nullable" : true }, "metrics" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "double", "description" : "Numeric aggregates (playMs, stallCount, wouldShowMs and more). 120 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a finite number. The server drops other entries.", "nullable" : true }, "description" : "Numeric aggregates (playMs, stallCount, wouldShowMs and more). 120 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a finite number. The server drops other entries.", "nullable" : true }, "playbackSessionId" : { "type" : "string", "description" : "A UUID that identifies the playback session. All flushes of the session use the same value. 64 characters maximum.", "nullable" : true }, "schemaVersion" : { "type" : "integer", "format" : "int32", "description" : "The version of the record format. Currently 1.", "example" : 1, "nullable" : true }, "seq" : { "type" : "integer", "format" : "int32", "description" : "The flush counter of the playback session.", "example" : 1, "nullable" : true }, "startTs" : { "type" : "integer", "format" : "int64", "description" : "Start of the playback session in epoch milliseconds. All flushes of the session use the same value. Must be in the last 48 hours.", "example" : 1790000000000, "nullable" : true }, "tabSessionId" : { "type" : "string", "description" : "Identifies the browser tab. 64 characters maximum.", "nullable" : true } }, "required" : [ "endTs", "playbackSessionId", "startTs" ] }, "MetricsAgentSettings" : { "type" : "object", "properties" : { "batch_on" : { "type" : "boolean", "default" : true, "nullable" : true }, "batch_size" : { "type" : "integer", "format" : "int32", "default" : 100000, "maximum" : 1000000, "minimum" : 10000, "nullable" : true }, "count_flush_interval" : { "type" : "integer", "format" : "int32", "default" : 1, "minimum" : 1, "nullable" : true }, "level" : { "$ref" : "#/components/schemas/MetricsLevelEnum" }, "log_update_interval" : { "type" : "integer", "format" : "int32", "default" : 1800, "minimum" : 1, "nullable" : true }, "server_flush_interval" : { "type" : "integer", "format" : "int32", "default" : 15, "minimum" : 1, "nullable" : true } } }, "MetricsAgentSettingsSelectiveUpdate" : { "type" : "object", "properties" : { "batch_on" : { "type" : "boolean", "default" : true, "nullable" : true }, "batch_size" : { "type" : "integer", "format" : "int32", "default" : 100000, "maximum" : 1000000, "minimum" : 10000, "nullable" : true }, "count_flush_interval" : { "type" : "integer", "format" : "int32", "default" : 1, "minimum" : 1, "nullable" : true }, "level" : { "$ref" : "#/components/schemas/MetricsLevelEnum" }, "log_update_interval" : { "type" : "integer", "format" : "int32", "default" : 1800, "minimum" : 1, "nullable" : true }, "server_flush_interval" : { "type" : "integer", "format" : "int32", "default" : 15, "minimum" : 1, "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true } } }, "MetricsLevelEnum" : { "type" : "string", "default" : "ESSENTIAL", "enum" : [ "OFF", "FILE", "ESSENTIAL", "BASIC", "FULL" ] }, "MfaTokenTypeEnum" : { "type" : "string", "enum" : [ "EMAIL", "SMS", "VIRTUAL_MFA", "FIDO" ] }, "MicrosoftTeamsChannelSettings" : { "type" : "object", "nullable" : true, "properties" : { "botInstallationId" : { "type" : "string", "nullable" : true }, "channelId" : { "type" : "string", "nullable" : true }, "installingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sendChannelNotifications" : { "type" : "boolean", "nullable" : true } } }, "MicrosoftTeamsSettings" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "webhookUrl" : { "type" : "string", "nullable" : true } } }, "MicrosoftTeamsType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "adminConsent" : { "type" : "boolean", "nullable" : true }, "allowUserNotifications" : { "type" : "boolean", "nullable" : true }, "microsoftTeamSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" }, "nullable" : true }, "microsoftTeamsUserSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" }, "nullable" : true }, "tenantId" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "MicrosoftTeamsUserSettings" : { "type" : "object", "nullable" : true, "properties" : { "botInstallationId" : { "type" : "string", "nullable" : true }, "chatId" : { "type" : "string", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "sendUserNotifications" : { "type" : "boolean", "nullable" : true }, "teamIds" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "userId" : { "type" : "string", "nullable" : true } } }, "MinimalAudioGatewayStateType" : { "type" : "object", "description" : "List of minimal audio gateway state information", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MinimalDeviceStateType" : { "type" : "object", "description" : "List of minimal camera state information", "properties" : { "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MinimalNVRStateType" : { "type" : "object", "description" : "List of minimal NVR state information for all NVRs in the organization", "properties" : { "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "numThirdPartyCamerasAssigned" : { "type" : "integer", "format" : "int32", "nullable" : true }, "numThirdPartyCamerasSupported" : { "type" : "integer", "format" : "int32", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MinimalObservableDeviceStateType" : { "type" : "object", "description" : "List of minimal state information for doorbell cameras", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MinimalRobotStateType" : { "type" : "object", "description" : "List of minimal device state information for robots", "properties" : { "activity" : { "type" : "string", "nullable" : true }, "activityStartedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "activityUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "activityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "batteryPercent" : { "type" : "integer", "format" : "int32", "nullable" : true }, "charging" : { "type" : "boolean", "nullable" : true }, "connectionStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "defaultInterface" : { "type" : "string", "nullable" : true }, "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, "distanceRemaining" : { "type" : "number", "format" : "float", "nullable" : true }, "estimatedTimeRemainingSec" : { "type" : "number", "format" : "double", "nullable" : true }, "event" : { "type" : "string", "nullable" : true }, "externalIPAddress" : { "type" : "string", "nullable" : true }, "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "failureReason" : { "type" : "string", "nullable" : true }, "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, "firmwareVersion" : { "type" : "string", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, "goalPose" : { "$ref" : "#/components/schemas/Pose" }, "healthStatus" : { "$ref" : "#/components/schemas/DeviceStatusEnum" }, "healthStatusDetails" : { "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "lastEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, "liveStreamShared" : { "type" : "boolean", "nullable" : true }, "liveStreamsSharedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "nullable" : true }, "mapId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "mediaRegion" : { "type" : "string", "nullable" : true }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/RobotOperatingModeEnum" }, "mummified" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "navPath" : { "type" : "array", "items" : { "type" : "number", "format" : "double", "nullable" : true }, "nullable" : true }, "navPathTsMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "navigationTimeSec" : { "type" : "number", "format" : "double", "nullable" : true }, "orientation" : { "type" : "number", "format" : "double", "nullable" : true }, "pathUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "phase" : { "type" : "string", "nullable" : true }, "phaseEvent" : { "type" : "string", "nullable" : true }, "phaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pose" : { "$ref" : "#/components/schemas/Pose" }, "poseUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "position" : { "type" : "number", "format" : "double", "nullable" : true }, "preemptedBy" : { "type" : "string", "nullable" : true }, "progressUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "region" : { "type" : "string", "nullable" : true }, "roamingLatitude" : { "type" : "number", "format" : "double", "nullable" : true }, "roamingLongitude" : { "type" : "number", "format" : "double", "nullable" : true }, "robotPlatform" : { "$ref" : "#/components/schemas/RobotPlatformEnum" }, "routeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "secondaryLanAddresses" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serialNumber" : { "type" : "string", "nullable" : true }, "ssid" : { "type" : "string", "nullable" : true }, "stateUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true }, "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "waypointIndex" : { "type" : "integer", "format" : "int32", "nullable" : true }, "waypointTotal" : { "type" : "integer", "format" : "int32", "nullable" : true }, "waypointUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "wifiApMac" : { "type" : "string", "nullable" : true }, "wifiBars" : { "type" : "integer", "format" : "int32", "nullable" : true }, "wifiSignalStrength" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MinimalThresholdEventType" : { "type" : "object", "description" : "List of threshold crossing events for the device", "properties" : { "crossingObject" : { "$ref" : "#/components/schemas/CrossingObjectEnum" }, "direction" : { "$ref" : "#/components/schemas/CrossingDirectionEnum" }, "objectId" : { "type" : "integer", "format" : "int32", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "MinuteOfDayIntervalType" : { "type" : "object", "properties" : { "dayOfWeek" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfDayStartInclusive" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfDayStopExclusive" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "MobileTokenOSEnum" : { "type" : "string", "enum" : [ "IOS", "ANDROID" ] }, "Mobile_AnswerDoorbellCallWSRequest" : { "type" : "object", "description" : "Request for the authenticated mobile session to answer (claim) a ringing doorbell call.", "properties" : { "callUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Mobile_AnswerDoorbellCallWSResponse" : { "type" : "object", "description" : "Outcome of a mobile session's attempt to answer a doorbell call.", "properties" : { "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "originatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "result" : { "$ref" : "#/components/schemas/RingClaimResultEnum" } } }, "Mobile_LoginToOrg2FARequiredResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "get2FAIdentifier" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "get2FAType" : { "$ref" : "#/components/schemas/MfaTokenTypeEnum" }, "numDaysSkip2FAForTrustedDevices" : { "type" : "integer", "format" : "int32", "description" : "Number of days to skip 2FA for trusted devices", "example" : 30, "nullable" : true } } } ], "description" : "Login to organization response indicating two-factor authentication is required.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Mobile_LoginToOrgBaseResponse" : { "type" : "object", "description" : "Base response object for login to organization operations with polymorphic response types.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Mobile_LoginToOrgSuccessResponse" }, { "$ref" : "#/components/schemas/Mobile_LoginToOrgSsoRequiredResponse" }, { "$ref" : "#/components/schemas/Mobile_LoginToOrg2FARequiredResponse" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "Mobile_LoginToOrgRequest" : { "type" : "object", "description" : "Request object for allowing a multi-org user on mobile to login to a different org they are able to access.", "properties" : { "csr" : { "type" : "array", "description" : "Certificate Signing Request (CSR) data", "items" : { "type" : "string", "format" : "byte", "description" : "Certificate Signing Request (CSR) data", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Mobile_LoginToOrgSsoRequiredResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "redirectUri" : { "type" : "string", "description" : "Redirect URI for SSO authentication", "example" : "https://sso.example.com/login", "nullable" : true } } } ], "description" : "Login to organization response indicating SSO authentication is required.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Mobile_LoginToOrgSuccessResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "cert" : { "type" : "array", "description" : "Certificate data for the successful login session", "items" : { "type" : "string", "format" : "byte", "description" : "Certificate data for the successful login session", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "description" : "Successful login to organization response containing session information.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Mobile_LoginVerifiedSupportAuthorityMobileRequest" : { "type" : "object", "description" : "Request object for mobile login of partner to client org as verified support authority.", "properties" : { "authorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientType" : { "$ref" : "#/components/schemas/SessionClientTypeEnum" } } }, "Mobile_LoginVerifiedSupportAuthorityMobileResponse" : { "type" : "object", "description" : "Response object for mobile login of partner to client org as verified support authority.", "properties" : { "supportAuthoritySessionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "valid" : { "type" : "boolean", "description" : "Whether the support authority login is valid", "example" : true, "nullable" : true } } }, "Mobile_LogoutMobileUserRequest" : { "type" : "object", "description" : "Request object for logging out a mobile user." }, "Mobile_LogoutMobileUserResponse" : { "type" : "object", "description" : "Response object for logging out a mobile user." }, "Mobile_RefreshMobileSessionRequest" : { "type" : "object", "description" : "Request object for refreshing a mobile session.", "properties" : { "csr" : { "type" : "array", "description" : "Certificate Signing Request (CSR) data", "items" : { "type" : "string", "format" : "byte", "description" : "Certificate Signing Request (CSR) data", "nullable" : true }, "nullable" : true } } }, "Mobile_RefreshMobileSessionResponse" : { "type" : "object", "description" : "Response object for refreshing a mobile session.", "properties" : { "cert" : { "type" : "array", "description" : "Certificate data for the refreshed session", "items" : { "type" : "string", "format" : "byte", "description" : "Certificate data for the refreshed session", "nullable" : true }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Mobile_UpdateMobileNotificationTokenRequest" : { "type" : "object", "description" : "Request object for updating mobile notification token for Console app.", "properties" : { "androidV2" : { "type" : "boolean", "description" : "Flag to use the new Android app", "nullable" : true }, "forceNewEndpoint" : { "type" : "boolean", "description" : "Forces the session to use the new SNS endpoint", "nullable" : true }, "platformIOS" : { "$ref" : "#/components/schemas/Mobile_UpdateMobileNotificationTokenRequest_PlatformIOS" }, "token" : { "type" : "string", "description" : "Mobile notification token", "example" : "abc123def456", "nullable" : true }, "voipToken" : { "type" : "string", "description" : "VoIP (PushKit) notification token for iOS doorbell ring pushes", "example" : "abc123def456", "nullable" : true } } }, "Mobile_UpdateMobileNotificationTokenRequest_PlatformIOS" : { "type" : "string", "description" : "SNS endpoint to use for iOS Console app", "enum" : [ "V1", "V2" ], "example" : "V1" }, "Mobile_UpdateMobileNotificationTokenResponse" : { "type" : "object", "description" : "Response object for updating mobile notification token for Console app." }, "Mobile_UpdateRhombusKeyMobileNotificationTokenRequest" : { "type" : "object", "description" : "Request object for updating mobile notification token for Rhombus Key app.", "properties" : { "token" : { "type" : "string", "description" : "Rhombus Key mobile notification token", "example" : "xyz789abc123", "nullable" : true } } }, "Mobile_UpdateRhombusKeyMobileNotificationTokenResponse" : { "type" : "object", "description" : "Response object for updating mobile notification token for Rhombus Key app." }, "ModelStatusEnum" : { "type" : "string", "enum" : [ "READY", "QUANTIZE_IN_PROGRESS", "QUANTIZE_FAILURE" ] }, "ModularAIConfig" : { "type" : "object", "description" : "List of available modular AI models", "properties" : { "description" : { "type" : "string", "nullable" : true }, "distributionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "modelParams" : { "$ref" : "#/components/schemas/ModularAIModelParams" }, "modelQuantizedBinaryContentLocator" : { "type" : "string", "nullable" : true }, "modelStatus" : { "$ref" : "#/components/schemas/ModelStatusEnum" }, "modelUploadZipContentLocator" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "pipeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineComponent" }, "nullable" : true }, "restrictedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ModularAIConfigSelectiveUpdate" : { "type" : "object", "description" : "Selective update configuration for the modular AI model", "properties" : { "description" : { "type" : "string", "nullable" : true }, "distributionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "modelParams" : { "$ref" : "#/components/schemas/ModularAIModelParams" }, "modelQuantizedBinaryContentLocator" : { "type" : "string", "nullable" : true }, "modelStatus" : { "$ref" : "#/components/schemas/ModelStatusEnum" }, "modelUploadZipContentLocator" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "pipeline" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineComponent" }, "nullable" : true }, "restrictedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { "type" : "boolean", "nullable" : true }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ModularAIDistribution" : { "type" : "object", "description" : "List of available modular AI distributions", "properties" : { "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "restrictedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ModularAIModelParams" : { "type" : "object", "properties" : { "classOutputMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "inputHeight" : { "type" : "integer", "format" : "int32", "nullable" : true }, "inputWidth" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Modularai_AddModelToDeviceWSRequest" : { "type" : "object", "description" : "Request object for adding a modular AI model to a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Modularai_AddModelToDeviceWSResponse" : { "type" : "object", "description" : "Response object for adding a modular AI model to a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_CreateModularAIDistributionWSRequest" : { "type" : "object", "description" : "Request object for creating a modular AI distribution.", "properties" : { "description" : { "type" : "string", "description" : "Description of the created model.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the created model.", "nullable" : true } } }, "Modularai_CreateModularAIDistributionWSResponse" : { "type" : "object", "description" : "Response object for creating a modular AI distribution.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_CreateModularAIPipelineConfigWSRequest" : { "type" : "object", "description" : "Request object for creating a modular AI pipeline config.", "properties" : { "description" : { "type" : "string", "description" : "Description of the created model.", "nullable" : true }, "distributionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the created model.", "nullable" : true }, "pipeline" : { "type" : "array", "description" : "List of pipeline components describing the behavior of the modular ai config.", "items" : { "$ref" : "#/components/schemas/PipelineComponent" }, "nullable" : true } } }, "Modularai_CreateModularAIPipelineConfigWSResponse" : { "type" : "object", "description" : "Response object for creating a modular AI pipeline config.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_GetDevicesForModelWSRequest" : { "type" : "object", "description" : "Request object for getting devices running a modular AI model.", "properties" : { "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Modularai_GetDevicesForModelWSResponse" : { "type" : "object", "description" : "Response object containing devices running a modular AI model.", "properties" : { "devices" : { "type" : "array", "description" : "List of device facet UUIDs running the modular AI model", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_GetModelsAddedToDeviceWSRequest" : { "type" : "object", "description" : "Request object for getting modular AI models added to a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, "Modularai_GetModelsAddedToDeviceWSResponse" : { "type" : "object", "description" : "Response object containing modular AI models added to a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "models" : { "type" : "array", "description" : "List of modular AI models added to the device", "items" : { "$ref" : "#/components/schemas/ModularAIConfig" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_GetModelsForDistributionWSRequest" : { "type" : "object", "description" : "Request object for getting modular AI models for a given distribution.", "properties" : { "distributionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Modularai_GetModelsForDistributionWSResponse" : { "type" : "object", "description" : "Response object containing available modular AI models for a given distribution.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "models" : { "type" : "array", "description" : "List of available modular AI models", "items" : { "$ref" : "#/components/schemas/ModularAIConfig" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_GetModelsWSRequest" : { "type" : "object", "description" : "Request object for getting available modular AI models." }, "Modularai_GetModelsWSResponse" : { "type" : "object", "description" : "Response object containing available modular AI models.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "models" : { "type" : "array", "description" : "List of available modular AI models", "items" : { "$ref" : "#/components/schemas/ModularAIConfig" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_ListModularAIDistributionsWSRequest" : { "type" : "object", "description" : "Request object for getting available modular AI distributions." }, "Modularai_ListModularAIDistributionsWSResponse" : { "type" : "object", "description" : "Response object containing available modular AI distributions.", "properties" : { "distributions" : { "type" : "array", "description" : "List of available modular AI distributions", "items" : { "$ref" : "#/components/schemas/ModularAIDistribution" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_RemoveModelFromDeviceWSRequest" : { "type" : "object", "description" : "Request object for removing a modular AI model from a device.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Modularai_RemoveModelFromDeviceWSResponse" : { "type" : "object", "description" : "Response object for removing a modular AI model from a device.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Modularai_UpdateModelWSRequest" : { "type" : "object", "description" : "Request object for updating modular AI model configuration.", "properties" : { "update" : { "$ref" : "#/components/schemas/ModularAIConfigSelectiveUpdate" } } }, "Modularai_UpdateModelWSResponse" : { "type" : "object", "description" : "Response object for updating modular AI model configuration." }, "MonitoringEnableStatus" : { "type" : "object", "description" : "Map of location UUIDs to their monitoring enable status", "properties" : { "devicesWithActiveSirens" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true }, "disabledOnMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledOnMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "noNextTimestampReason" : { "type" : "string", "nullable" : true }, "notEnabledReason" : { "type" : "string", "nullable" : true }, "recentlyActivatedSirensTimestampMs" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64", "nullable" : true }, "nullable" : true } } }, "MonitoringModeEnum" : { "type" : "string", "enum" : [ "MANUAL", "SCHEDULED", "UNKNOWN" ] }, "MspApproval" : { "type" : "object", "nullable" : true, "properties" : { "adminUser" : { "type" : "string", "nullable" : true }, "timestampMillis" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "MspDesignationStatusEnum" : { "type" : "string", "enum" : [ "PENDING_APPROVAL", "ACTIVE", "REVOKED", "UNKNOWN" ] }, "MspDesignationType" : { "type" : "object", "nullable" : true, "properties" : { "agreementRef" : { "type" : "string", "nullable" : true }, "approvals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MspApproval" }, "nullable" : true }, "contractSignedDate" : { "type" : "integer", "format" : "int64", "nullable" : true }, "keyId" : { "type" : "string", "nullable" : true }, "proposedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "salesforceAccountId" : { "type" : "string", "nullable" : true }, "signature" : { "type" : "string", "description" : "Base64 ECDSA (P-256, SHA-256) signature over the canonical designation payload.", "nullable" : true }, "signedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "source" : { "type" : "string", "description" : "How the designation landed: SALESFORCE_PULL or ADMIN_SYNC.", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/MspDesignationStatusEnum" } } }, "MultiPart" : { "type" : "object", "nullable" : true, "properties" : { "bodyParts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BodyPart" }, "nullable" : true }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "entity" : { "type" : "object", "nullable" : true }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "parameterizedHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "providers" : { "$ref" : "#/components/schemas/Providers" } } }, "MultivaluedMapStringObject" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "MultivaluedMapStringParameterizedHeader" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "MultivaluedMapStringString" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true, "properties" : { "empty" : { "type" : "boolean", "nullable" : true } } }, "NavigationTypeEnum" : { "type" : "string", "enum" : [ "ROUTE", "PATROL", "WAYPOINT", "POSE" ] }, "NetsuiteInvoiceDetails" : { "type" : "object", "properties" : { "billingContactEmail" : { "type" : "string", "nullable" : true }, "billingContactName" : { "type" : "string", "nullable" : true }, "billingcontactemail" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "billingcontactname" : { "type" : "string", "nullable" : true }, "clientOrgName" : { "type" : "string", "nullable" : true }, "clientorgname" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "dueDate" : { "type" : "string", "nullable" : true }, "duedate" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "invoiceDate" : { "type" : "string", "nullable" : true }, "invoiceUuid" : { "type" : "string", "nullable" : true }, "invoicedate" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "invoiceinternalid" : { "type" : "string", "nullable" : true }, "invoiceuuid" : { "type" : "string", "nullable" : true }, "lineItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LineItems" }, "nullable" : true }, "lineitems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LineItems" }, "nullable" : true }, "partnerOrgName" : { "type" : "string", "nullable" : true }, "partnerorgname" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "paymentid" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true }, "totalBalance" : { "type" : "number", "nullable" : true }, "totalbalance" : { "type" : "number", "nullable" : true }, "transactionId" : { "type" : "string", "nullable" : true }, "transactionid" : { "type" : "string", "nullable" : true, "writeOnly" : true }, "unpaidBalance" : { "type" : "number", "nullable" : true }, "unpaidbalance" : { "type" : "number", "nullable" : true, "writeOnly" : true } } }, "Network_GetDeviceNetworkConfigurationWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Network_GetDeviceNetworkConfigurationWSResponse" : { "type" : "object", "properties" : { "ipConfigurations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Network_IpConfiguration" }, "nullable" : true } } }, "Network_IpConfiguration" : { "type" : "object", "properties" : { "dnsServer1" : { "type" : "string", "description" : "Primary DNS server. Will only be set if mode is STATIC.", "nullable" : true }, "dnsServer2" : { "type" : "string", "description" : "Secondary DNS server. Will only be set if mode is STATIC.", "nullable" : true }, "gateway" : { "type" : "string", "description" : "Gateway address. Will only be set if mode is STATIC.", "nullable" : true }, "ipAddress" : { "type" : "string", "description" : "IP address. Will only be set if mode is STATIC.", "nullable" : true }, "isSecondary" : { "type" : "boolean", "description" : "Indicates whether this IP configuration is secondary. Default is false (primary).", "nullable" : true }, "mode" : { "$ref" : "#/components/schemas/Network_NetworkConfigurationModeEnum" }, "netmask" : { "type" : "string", "description" : "Subnet mask. Will only be set if mode is STATIC.", "nullable" : true } } }, "Network_NetworkConfigurationModeEnum" : { "type" : "string", "description" : "Network configuration mode for devices.", "enum" : [ "DHCP", "STATIC" ] }, "Network_UpdateDeviceIpConfigurationWSRequest" : { "type" : "object", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ipConfiguration" : { "$ref" : "#/components/schemas/Network_IpConfiguration" } } }, "Network_UpdateDeviceIpConfigurationWSResponse" : { "type" : "object", "properties" : { "ipConfiguration" : { "$ref" : "#/components/schemas/Network_IpConfiguration" } } }, "NewCookie" : { "type" : "object", "nullable" : true, "properties" : { "comment" : { "type" : "string", "nullable" : true }, "domain" : { "type" : "string", "nullable" : true }, "expiry" : { "type" : "string", "format" : "date-time", "nullable" : true }, "httpOnly" : { "type" : "boolean", "nullable" : true }, "maxAge" : { "type" : "integer", "format" : "int32", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "path" : { "type" : "string", "nullable" : true }, "sameSite" : { "$ref" : "#/components/schemas/JakartaSameSiteEnum" }, "secure" : { "type" : "boolean", "nullable" : true }, "value" : { "type" : "string", "nullable" : true }, "version" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "NewGuestPassCredentialSpec" : { "type" : "object", "description" : "Polymorphic credential creation spec. Discriminated on the AccessControlCredentialEnumType value in the 'type' field. PIN_CODE and QR_CODE_STATIC are currently supported.", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/PinCodeNewGuestPassCredentialSpec" }, { "$ref" : "#/components/schemas/QrCodeStaticNewGuestPassCredentialSpec" } ], "properties" : { "type" : { "type" : "string", "description" : "Discriminator for the credential type to create.", "nullable" : true } }, "required" : [ "type" ] }, "NineOneOneCellularType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "bearerToken" : { "type" : "string", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "securityZoneMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SecurityZoneInfoType" }, "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "zonesValidated" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "NoOpAction" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/RobotActionTypeEnum" } } }, "NoonlightPromptSelection" : { "type" : "object", "description" : "The threat qualification prompt to update.", "properties" : { "mutable" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "reasons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightReasonEnum" }, "nullable" : true, "uniqueItems" : true }, "title" : { "type" : "string", "nullable" : true } } }, "NoonlightPromptThemeEnum" : { "type" : "string", "enum" : [ "THREAT", "HUMAN" ] }, "NoonlightReasonEnum" : { "type" : "string", "enum" : [ "NO_PERSON", "ROUTINE_EMPLOYEE", "PERSON_OUTSIDE", "PERSON_INSIDE", "OTHER", "SERVICES_ONSITE", "MOVING_VEHICLE", "CAMERA_OBSTRUCTED", "VIDEO_ISSUE", "PERSON_OTHER", "NO_PERSON_OTHER", "LOAD_FAILURE", "ACTIVE_CRIME", "UNKNOWN_PERSON_INSIDE", "UNKNOWN_SUSPECT_OUTSIDE", "UNKNOWN_SUSPECT_INSIDE", "UNKNOWN_PERSON_OUTSIDE", "OTHER_CONCLUSIVE_RESULT", "TIMEOUT" ] }, "NoonlightScheduleType" : { "type" : "object", "properties" : { "audioGateways" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "escalationDelayMinutes" : { "type" : "integer", "format" : "int32", "nullable" : true }, "monitoredDevices" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "promptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "promptTitle" : { "type" : "string", "nullable" : true }, "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "sirenSettings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AMSirenSettingsType" }, "nullable" : true }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "tripwire" : { "$ref" : "#/components/schemas/TripwireSettings" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "verifiedThreatSiren" : { "$ref" : "#/components/schemas/AMSirenSettingsType" } } }, "NoonlightSettings" : { "type" : "object", "properties" : { "acceptedTermsOfService" : { "type" : "boolean", "nullable" : true }, "defaultContactsByLocationMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EmergencyContact" }, "nullable" : true }, "defaultDelayByLocationsMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "defaultPromptByLocationsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "nullable" : true }, "emergencyContactsByLocationsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmergencyResponseContactsIntervalType" }, "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "escalationSettingsByLocationsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertMonitoringSubmissionDelayIntervalType" }, "nullable" : true }, "nullable" : true }, "locationEntryInstructionsMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "pinsByLocationMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertMonitoringPinType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "verificationPrompt" : { "type" : "string", "nullable" : true } } }, "NoonlightVersionedSettingsType" : { "type" : "object", "description" : "Updated alert monitoring settings configuration for the location", "properties" : { "acceptedTermsOfService" : { "type" : "boolean", "nullable" : true }, "badgeAuthDisablesMonitoring" : { "type" : "boolean", "nullable" : true }, "defaultDelay" : { "type" : "integer", "format" : "int32", "nullable" : true }, "defaultEmergencyContact" : { "$ref" : "#/components/schemas/EmergencyContact" }, "defaultPromptTheme" : { "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "emergencyContacts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "entryInstructions" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "manualEscalationSettings" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "modifiedByEmail" : { "type" : "string", "nullable" : true }, "modifiedByIntegration" : { "type" : "boolean", "nullable" : true }, "modifiedByMetadata" : { "type" : "string", "nullable" : true }, "modifiedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "modifiedTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "monitoringMode" : { "$ref" : "#/components/schemas/MonitoringModeEnum" }, "oneTimePauses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "oneTimeSchedules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pins" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertMonitoringPinType" }, "nullable" : true, "uniqueItems" : true }, "rules" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "schedules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "talkdownEnabled" : { "type" : "boolean", "nullable" : true } } }, "NormalStateEnumType" : { "type" : "string", "enum" : [ "NO", "NC" ] }, "NotificationEnumType" : { "type" : "string", "enum" : [ "SMS", "EMAIL", "APP", "SLACK", "MICROSOFT_TEAMS", "BROWSER", "UNKNOWN" ] }, "NotificationFollowUp" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "userUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } } ], "nullable" : true, "properties" : { "type" : { "$ref" : "#/components/schemas/ChatFollowUpActionEnum" } } }, "NotificationIntervalV2Type" : { "type" : "object", "properties" : { "activityTriggerMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "deviceFilterSet" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "diagnosticTriggerMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "locationActivityTriggerMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "locationDiagnosticTriggerMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "locationFilterSet" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationOnlyFilterSet" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", "nullable" : true }, "minuteOfWeekStop" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "NotificationSettingsType" : { "type" : "object", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "slackChannel" : { "type" : "string", "nullable" : true }, "slackEnabled" : { "type" : "boolean", "nullable" : true }, "slackWebhookUrl" : { "type" : "string", "nullable" : true } } }, "NotificationTimeFrame" : { "type" : "object", "properties" : { "days" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" }, "nullable" : true, "uniqueItems" : true }, "interval" : { "$ref" : "#/components/schemas/MinuteOfDayIntervalType" }, "mediums" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true }, "rows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationTimeFrameRow" }, "nullable" : true } } }, "NotificationTimeFrameRow" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "devices" : { "type" : "array", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "diagnostics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DiagnosticActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "locationOnly" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "locationOnlyActivities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "locationOnlyDiagnostics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DiagnosticActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "locations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "promptUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, "NumericAggregationValue" : { "type" : "object", "description" : "Map of numeric count reports", "properties" : { "average" : { "type" : "number", "format" : "double", "nullable" : true }, "eventCount" : { "type" : "integer", "format" : "int64", "nullable" : true }, "localDate" : { "type" : "string", "nullable" : true }, "max" : { "type" : "number", "format" : "double", "nullable" : true }, "maxValueTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "min" : { "type" : "number", "format" : "double", "nullable" : true }, "minValueTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "sum" : { "type" : "number", "format" : "double", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "utcDate" : { "type" : "string", "nullable" : true } } }, "OAuthApplication" : { "type" : "object", "description" : "OAuth application details", "properties" : { "clientId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientSecretHash" : { "type" : "string", "nullable" : true }, "contactEmail" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "publicClient" : { "type" : "boolean", "nullable" : true }, "redirectUri" : { "type" : "string", "nullable" : true }, "tokenEndpointAuthMethod" : { "type" : "string", "nullable" : true } } }, "OPERATOREnum" : { "type" : "string", "enum" : [ "GT", "LT", "LTE", "GTE", "EQ", "CONTAINS" ] }, "Oauth_GetAllApplicationsForOrgWSRequest" : { "type" : "object", "description" : "Request object for getting all OAuth applications for an organization." }, "Oauth_GetAllApplicationsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing all OAuth applications for an organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "oauthApplications" : { "type" : "array", "description" : "List of OAuth applications for the organization", "items" : { "$ref" : "#/components/schemas/OAuthApplication" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Oauth_GetApplicationByClientIdWSRequest" : { "type" : "object", "description" : "Request object for getting OAuth application by client ID.", "properties" : { "clientId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Oauth_GetApplicationByClientIdWSResponse" : { "type" : "object", "description" : "Response object containing OAuth application details.", "properties" : { "application" : { "$ref" : "#/components/schemas/OAuthApplication" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Oauth_OAuthApplicationWSRequest" : { "type" : "object", "description" : "Request object for OAuth application management.", "properties" : { "clientId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "contactEmail" : { "type" : "string", "description" : "Contact email for the OAuth application", "example" : "admin@myapp.com", "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the OAuth application", "example" : "Integration app for accessing Rhombus API", "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the OAuth application", "example" : "My Integration App", "nullable" : true }, "redirectUri" : { "type" : "string", "description" : "OAuth redirect URI", "example" : "https://myapp.com/oauth/callback", "nullable" : true }, "tokenEndpointAuthMethod" : { "type" : "string", "description" : "OAuth token endpoint auth method. 'none' registers a PUBLIC (PKCE-only) client with no secret; omit or 'client_secret_basic'/'client_secret_post' for a confidential client.", "example" : "none", "nullable" : true } } }, "Oauth_OAuthApplicationWSResponse" : { "type" : "object", "description" : "Response object containing OAuth application credentials.", "properties" : { "clientId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientSecret" : { "type" : "string", "description" : "OAuth client secret", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "ObjectSearchModelEnum" : { "type" : "string", "description" : "Model used for embeddings. The streaming variant of this search accepts only \"CHARON\".", "enum" : [ "CLIP_512", "CHARON" ] }, "ObjectSearchQuery" : { "type" : "object", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "query" : { "type" : "string", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Objectsearchtracking_CreateObjectSearchQueryWSRequest" : { "type" : "object", "description" : "Request to save a Custom Detection.", "properties" : { "query" : { "type" : "string", "description" : "Search text to save; a Custom Detection is named by its text", "nullable" : true } } }, "Objectsearchtracking_CreateObjectSearchQueryWSResponse" : { "type" : "object", "description" : "The saved Custom Detection.", "properties" : { "moderationReason" : { "type" : "string", "description" : "Why moderation rejected the text", "nullable" : true }, "objectSearchQuery" : { "$ref" : "#/components/schemas/ObjectSearchQuery" }, "queryAllowed" : { "type" : "boolean", "description" : "False when the text was rejected by moderation", "nullable" : true } } }, "Objectsearchtracking_CreateTrackedObjectSearchWSRequest" : { "type" : "object", "description" : "Request to save a Custom Detection search.", "properties" : { "deviceFacetUuids" : { "type" : "array", "description" : "Cameras to record sightings on; required and must name at least one", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "query" : { "type" : "string", "description" : "CHARON text query to record sightings for", "nullable" : true } } }, "Objectsearchtracking_CreateTrackedObjectSearchWSResponse" : { "type" : "object", "description" : "The saved Custom Detection search.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "moderationReason" : { "type" : "string", "description" : "Why moderation rejected the query", "nullable" : true }, "queryAllowed" : { "type" : "boolean", "description" : "False when the query was rejected by moderation", "nullable" : true }, "trackedObjectSearch" : { "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Objectsearchtracking_DeleteTrackedObjectSearchWSRequest" : { "type" : "object", "description" : "Request to stop a saved Custom Detection search.", "properties" : { "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Objectsearchtracking_DeleteTrackedObjectSearchWSResponse" : { "type" : "object", "description" : "Result of stopping a saved Custom Detection search.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Objectsearchtracking_GetTrackedObjectSearchWSRequest" : { "type" : "object", "description" : "Request for one saved Custom Detection search.", "properties" : { "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Objectsearchtracking_GetTrackedObjectSearchWSResponse" : { "type" : "object", "description" : "One saved Custom Detection search.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "trackedObjectSearch" : { "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Objectsearchtracking_ListObjectSearchQueriesWSRequest" : { "type" : "object", "description" : "Request for the org's saved Custom Detections.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Objectsearchtracking_ListObjectSearchQueriesWSResponse" : { "type" : "object", "description" : "The org's saved Custom Detections.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "description" : "Opaque continuation key; absent on the last page", "nullable" : true }, "objectSearchQueries" : { "type" : "array", "description" : "Saved Custom Detections, one per query", "items" : { "$ref" : "#/components/schemas/ObjectSearchQuery" }, "nullable" : true } } }, "Objectsearchtracking_ListTrackedObjectSearchesWSRequest" : { "type" : "object", "description" : "Request for the org's saved Custom Detection searches." }, "Objectsearchtracking_ListTrackedObjectSearchesWSResponse" : { "type" : "object", "description" : "The org's saved Custom Detection searches.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "trackedObjectSearches" : { "type" : "array", "description" : "Saved Custom Detection searches with their queries", "items" : { "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Objectsearchtracking_SearchTrackedObjectSearchMatchesWSRequest" : { "type" : "object", "description" : "Request for recorded Custom Detection sightings.", "properties" : { "endTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Inclusive end of the sighting window", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Page token from a previous response", "nullable" : true }, "startTimestampMs" : { "type" : "integer", "format" : "int64", "description" : "Inclusive start of the sighting window", "nullable" : true }, "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Objectsearchtracking_SearchTrackedObjectSearchMatchesWSResponse" : { "type" : "object", "description" : "Recorded Custom Detection sightings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "lastEvaluatedKey" : { "type" : "string", "description" : "Page token to fetch the next page, absent on the last page", "nullable" : true }, "matches" : { "type" : "array", "description" : "Sightings, newest first", "items" : { "$ref" : "#/components/schemas/TrackedObjectSearchMatch" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Objectsearchtracking_UpdateTrackedObjectSearchWSRequest" : { "type" : "object", "description" : "Request to change a saved Custom Detection search's camera scope or state.", "properties" : { "deviceFacetUuids" : { "type" : "array", "description" : "Replacement camera scope; required and must name at least one", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "isArchived" : { "type" : "boolean", "description" : "Archive or restore; omit to leave unchanged", "nullable" : true }, "isPaused" : { "type" : "boolean", "description" : "Stop or resume recording new sightings; omit to leave unchanged", "nullable" : true }, "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Objectsearchtracking_UpdateTrackedObjectSearchWSResponse" : { "type" : "object", "description" : "The updated saved Custom Detection search.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "trackedObjectSearch" : { "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "OccupancyEventType" : { "type" : "object", "description" : "List of occupancy events for the sensor", "properties" : { "baseStationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "batteryPercentage" : { "type" : "integer", "format" : "int32", "nullable" : true }, "bleDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "bleRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, "closeBaseStations" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "lux" : { "type" : "integer", "format" : "int32", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "state" : { "$ref" : "#/components/schemas/OccupancyStateEnum" }, "stateChanged" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "tampered" : { "type" : "boolean", "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "OccupancyPolicyType" : { "type" : "object", "description" : "List of occupancy policies using the schedule", "properties" : { "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "scheduledTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OccupancyScheduledTriggerType" }, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OccupancyScheduledTriggerType" : { "type" : "object", "properties" : { "occupancyThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, "schedule" : { "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, "triggerSet" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "vacancyThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "OccupancyStateEnum" : { "type" : "string", "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] }, "OccupancyStatusEnum" : { "type" : "string", "description" : "Current occupancy status of the sensor", "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] }, "Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" : { "type" : "object", "description" : "Request object for getting minimal occupancy sensor states for all sensors in organization." }, "Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" : { "type" : "object", "description" : "Response object containing minimal occupancy sensor states for all sensors in organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "occupancySensorStates" : { "type" : "array", "description" : "List of minimal occupancy sensor states", "items" : { "$ref" : "#/components/schemas/Occupancysensor_MinimalOccupancySensorStateType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Occupancysensor_GetOccupancyEventsForSensorWSRequest" : { "type" : "object", "description" : "Request object for getting occupancy events for a specific sensor.", "properties" : { "createdAfterMs" : { "type" : "integer", "format" : "int64", "description" : "Filter events created after this timestamp (milliseconds since epoch)", "example" : 1640908800000, "nullable" : true }, "createdBeforeMs" : { "type" : "integer", "format" : "int64", "description" : "Filter events created before this timestamp (milliseconds since epoch)", "example" : 1640995200000, "nullable" : true }, "limit" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of events to return", "example" : 100, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Occupancysensor_GetOccupancyEventsForSensorWSResponse" : { "type" : "object", "description" : "Response object containing occupancy events for a specific sensor.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "events" : { "type" : "array", "description" : "List of occupancy events for the sensor", "items" : { "$ref" : "#/components/schemas/OccupancyEventType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Occupancysensor_MinimalOccupancySensorStateType" : { "type" : "object", "description" : "Minimal state information for occupancy sensors including health, location, and sensor data.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "batteryPercent" : { "type" : "integer", "format" : "int32", "description" : "Battery percentage of the sensor", "example" : 85, "nullable" : true }, "closestBaseStation" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "firmwareVersion" : { "type" : "string", "description" : "Firmware version of the sensor", "example" : "1.2.3", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the sensor is located", "example" : 2, "nullable" : true }, "health" : { "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthEnum" }, "healthDetails" : { "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthDetailsEnum" }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "lastSeenSec" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the sensor was last seen (seconds since epoch)", "example" : 1640995200, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the sensor location", "example" : 37.7749, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the sensor location", "example" : -122.4194, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the occupancy sensor", "example" : "Conference Room Sensor", "nullable" : true }, "normalizedLux" : { "type" : "number", "format" : "float", "description" : "Normalized lux value (0-1) matching human perception of lighting transitions", "example" : 0.75, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rawLux" : { "type" : "integer", "format" : "int32", "description" : "Raw lux value from the sensor", "example" : 500, "nullable" : true }, "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the occupancy sensor", "example" : "RH123456789", "nullable" : true }, "signalStrength" : { "type" : "integer", "format" : "int32", "description" : "Signal strength of the sensor", "example" : -45, "nullable" : true }, "status" : { "$ref" : "#/components/schemas/OccupancyStatusEnum" }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "Occupancysensor_MotionSensorHealthDetailsEnum" : { "type" : "string", "description" : "Detailed motion sensor health status.", "enum" : [ "NO_HEARTBEAT", "FIRMWARE_BEHIND", "NONE" ] }, "Occupancysensor_MotionSensorHealthEnum" : { "type" : "string", "description" : "Motion sensor health status.", "enum" : [ "RED", "GREEN" ] }, "Occupancysensor_UpdateOccupancySensorDetailsWSRequest" : { "type" : "object", "description" : "Request object for updating occupancy sensor details with selective update flags.", "properties" : { "associatedCameras" : { "type" : "array", "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, "associatedCamerasUpdated" : { "type" : "boolean", "description" : "Whether the associated cameras should be updated", "example" : false, "nullable" : true }, "deleted" : { "type" : "boolean", "description" : "Whether the sensor is marked as deleted", "example" : false, "nullable" : true }, "deletedUpdated" : { "type" : "boolean", "description" : "Whether the deleted status should be updated", "example" : false, "nullable" : true }, "description" : { "type" : "string", "description" : "Description of the occupancy sensor", "example" : "Motion sensor for conference room A", "nullable" : true }, "descriptionUpdated" : { "type" : "boolean", "description" : "Whether the description should be updated", "example" : false, "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", "description" : "Floor number where the sensor is located", "example" : 2, "nullable" : true }, "floorNumberUpdated" : { "type" : "boolean", "description" : "Whether the floor number should be updated", "example" : false, "nullable" : true }, "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude coordinate of the sensor location", "example" : 37.7749, "nullable" : true }, "latitudeUpdated" : { "type" : "boolean", "description" : "Whether the latitude should be updated", "example" : false, "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuidUpdated" : { "type" : "boolean", "description" : "Whether the location UUID should be updated", "example" : false, "nullable" : true }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude coordinate of the sensor location", "example" : -122.4194, "nullable" : true }, "longitudeUpdated" : { "type" : "boolean", "description" : "Whether the longitude should be updated", "example" : false, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the occupancy sensor", "example" : "Conference Room Sensor", "nullable" : true }, "nameUpdated" : { "type" : "boolean", "description" : "Whether the name should be updated", "example" : false, "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuidUpdated" : { "type" : "boolean", "description" : "Whether the policy UUID should be updated", "example" : false, "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", "description" : "Whether the sub-locations hierarchy key should be updated", "example" : false, "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Occupancysensor_UpdateOccupancySensorDetailsWSResponse" : { "type" : "object", "description" : "Response object for updating occupancy sensor details.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "OccupiedActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "occupancyThresholdSec" : { "type" : "integer", "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { "activityEvent" : { "$ref" : "#/components/schemas/ActivityEnum" } } }, "Office365Settings" : { "type" : "object", "description" : "Office 365 integration settings to update", "properties" : { "driveId" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "tenantId" : { "type" : "string", "nullable" : true } } }, "OmnialertType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "triggerNotification" : { "type" : "boolean", "nullable" : true }, "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OnGuardDeploymentSettings" : { "type" : "object", "nullable" : true, "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, "badgeFaceVerificationMode" : { "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "displayName" : { "type" : "string", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorsValidated" : { "type" : "boolean", "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "presharedSecret" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "OnvifPtzCapabilitiesResponse" : { "type" : "object", "properties" : { "continuousPanTilt" : { "type" : "boolean", "nullable" : true }, "continuousZoom" : { "type" : "boolean", "nullable" : true }, "realtimePtz" : { "type" : "boolean", "nullable" : true }, "report" : { "$ref" : "#/components/schemas/JsonNode" } } }, "OpStatusEnum" : { "type" : "string", "description" : "Why it failed. ERROR_DUPLICATE means a door already sits at that address.", "enum" : [ "SUCCESS", "ERROR_DUPLICATE", "ERROR_GENERIC", "ERROR_GENERIC_RETRY" ] }, "OpenAIModel" : { "type" : "object", "description" : "List of available OpenAI models", "properties" : { "created" : { "type" : "string", "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "object" : { "type" : "string", "nullable" : true }, "ownedBy" : { "type" : "string", "nullable" : true }, "owned_by" : { "type" : "string", "nullable" : true } } }, "OpenAIType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiToken" : { "type" : "string", "nullable" : true }, "baseUrl" : { "type" : "string", "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", "nullable" : true }, "defaultModel" : { "type" : "string", "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", "nullable" : true }, "refreshToken" : { "type" : "string", "nullable" : true }, "tokenValid" : { "type" : "boolean", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Openapi_GetOpenApiComponentSchemasWSRequest" : { "type" : "object", "description" : "Request object for exposing custom objects and enums to OpenAPI component schemas.", "properties" : { "changeType" : { "$ref" : "#/components/schemas/ChangeTypeEnum" }, "entity" : { "$ref" : "#/components/schemas/EntityEnum" }, "locationFunctionality" : { "$ref" : "#/components/schemas/LocationFunctionalityEnum" } } }, "OpenpathSettings" : { "type" : "object", "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, "doorToCameraMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "nullable" : true }, "email" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "eventToWebhookIdMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "eventToWebhookMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/WebhookMapEntry" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true }, "password" : { "type" : "string", "nullable" : true }, "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true }, "webhookId" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "OpentechAllianceActionGroupType" : { "type" : "object", "properties" : { "actionGroupId" : { "type" : "string", "nullable" : true }, "deviceId" : { "type" : "string", "nullable" : true }, "locationName" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "OpentechAllianceDoorInfoType" : { "type" : "object", "nullable" : true, "properties" : { "actionGroupId" : { "type" : "string", "nullable" : true }, "assignedCameraList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "clipDuration" : { "type" : "integer", "format" : "int32", "nullable" : true }, "doorName" : { "type" : "string", "nullable" : true }, "leadingSeconds" : { "type" : "integer", "format" : "int32", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "remoteUnlock" : { "type" : "boolean", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, "OpentechAllianceFacilitySettings" : { "type" : "object", "nullable" : true, "properties" : { "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, "createSeekPoints" : { "type" : "boolean", "nullable" : true }, "doorInfoMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OpentechAllianceDoorInfoType" }, "nullable" : true }, "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, "saveClips" : { "type" : "boolean", "nullable" : true } } }, "OpentechAllianceFacilityType" : { "type" : "object", "properties" : { "actionGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OpentechAllianceActionGroupType" }, "nullable" : true }, "deviceList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DoorType" }, "nullable" : true }, "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "OpentechAllianceSettings" : { "type" : "object", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "apiSecret" : { "type" : "string", "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "facilityToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" }, "nullable" : true }, "migrated" : { "type" : "boolean", "nullable" : true } } }, "OpentechAllianceType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "apiKey" : { "type" : "string", "nullable" : true }, "apiSecret" : { "type" : "string", "nullable" : true }, "facilityToSettingsMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" }, "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OperationStatus" : { "type" : "object", "description" : "Map of device serial numbers to their reassignment operation status", "properties" : { "message" : { "type" : "string", "nullable" : true }, "status" : { "$ref" : "#/components/schemas/StatusTypeEnum" } } }, "OrgGroupEnumType" : { "type" : "string", "enum" : [ "RHOMBUS_ACCESS_CONTROL", "GUEST_MANAGEMENT_HOST" ] }, "OrgGroupMemberType" : { "type" : "object", "description" : "List of user group memberships", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/OrgGroupEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OrgGroupType" : { "type" : "object", "description" : "Guest management host group", "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/OrgGroupEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OrgIntegrationsType" : { "type" : "object", "description" : "Organization integrations configuration and settings", "properties" : { "amtSettings" : { "$ref" : "#/components/schemas/AmtSettings" }, "awsSettings" : { "$ref" : "#/components/schemas/AwsSettings" }, "backblazeSettings" : { "$ref" : "#/components/schemas/BackblazeSettings" }, "boxSettings" : { "$ref" : "#/components/schemas/BoxSettings" }, "brivoSettings" : { "$ref" : "#/components/schemas/BrivoSettings" }, "butterflymxSettings" : { "$ref" : "#/components/schemas/ButterflyMXSettings" }, "diceSettings" : { "$ref" : "#/components/schemas/DiceSettings" }, "dropboxSettingsV2" : { "$ref" : "#/components/schemas/DropboxSettingsV2" }, "emailSettings" : { "$ref" : "#/components/schemas/EmailSettings" }, "envoySettings" : { "$ref" : "#/components/schemas/EnvoySettings" }, "geneaSettings" : { "$ref" : "#/components/schemas/GeneaSettings" }, "googleSettings" : { "$ref" : "#/components/schemas/GoogleSettings" }, "googleSettingsV2" : { "$ref" : "#/components/schemas/GoogleSettingsV2" }, "haloSettings" : { "$ref" : "#/components/schemas/HaloSettings" }, "immixSettings" : { "$ref" : "#/components/schemas/ImmixSettings" }, "intuifaceSettings" : { "$ref" : "#/components/schemas/IntuifaceSettings" }, "kisiSettings" : { "$ref" : "#/components/schemas/KisiSettings" }, "lumeoSettings" : { "$ref" : "#/components/schemas/LumeoSettings" }, "mattermostSettings" : { "$ref" : "#/components/schemas/MattermostSettings" }, "microsoftTeamsSettings" : { "$ref" : "#/components/schemas/MicrosoftTeamsSettings" }, "noonlightSettings" : { "$ref" : "#/components/schemas/NoonlightSettings" }, "office365Settings" : { "$ref" : "#/components/schemas/Office365Settings" }, "openpathSettings" : { "$ref" : "#/components/schemas/OpenpathSettings" }, "opentechAllianceSettings" : { "$ref" : "#/components/schemas/OpentechAllianceSettings" }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pagerDutySettings" : { "$ref" : "#/components/schemas/PagerDutySettings" }, "placeOsSettings" : { "$ref" : "#/components/schemas/PlaceOsSettings" }, "proDataKeySettings" : { "$ref" : "#/components/schemas/ProDataKeySettings" }, "saltoSettings" : { "$ref" : "#/components/schemas/SaltoSettings" }, "serviceNowSettings" : { "$ref" : "#/components/schemas/ServiceNowSettings" }, "slackSettings" : { "$ref" : "#/components/schemas/SlackSettings" }, "slackSettingsV2" : { "$ref" : "#/components/schemas/SlackSettingsV2" }, "squareSettings" : { "$ref" : "#/components/schemas/SquareSettings" }, "toastSettings" : { "$ref" : "#/components/schemas/ToastSettings" }, "tpLinkSettings" : { "$ref" : "#/components/schemas/TPLinkSettings" }, "tritonSettings" : { "$ref" : "#/components/schemas/TritonSettings" }, "twilioSettings" : { "$ref" : "#/components/schemas/TwilioSettings" }, "webhookSettings" : { "$ref" : "#/components/schemas/WebhookSettings" } } }, "OrgLicenseStats" : { "type" : "object", "description" : "License statistics for the organization", "properties" : { "acuDoorLicenseStats" : { "$ref" : "#/components/schemas/LicenseGroupStats" }, "alertMonitoringLicenseStats" : { "$ref" : "#/components/schemas/LicenseGroupStats" }, "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, "assignedLicenseStateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "deviceLicenseStats" : { "$ref" : "#/components/schemas/DeviceAssignableLicenseGroupStats" }, "guestManagementLicenseStats" : { "$ref" : "#/components/schemas/LicenseGroupStats" }, "lastEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, "licenseUsageStats" : { "$ref" : "#/components/schemas/LicenseUsageStats" }, "nearExpirationCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, "nextEndDate" : { "type" : "string", "format" : "date-time", "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, "paneLicenseStats" : { "$ref" : "#/components/schemas/LicenseGroupStats" }, "stateStats" : { "$ref" : "#/components/schemas/LicenseStateStats" }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "The number of licenses in the group.", "nullable" : true } } }, "OrgLockdownPlanType" : { "type" : "object", "allOf" : [ ], "nullable" : true, "properties" : { "activationPlan" : { "$ref" : "#/components/schemas/LockdownActivationPlanType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "deactivationPlan" : { "$ref" : "#/components/schemas/LockdownDeactivationPlanType" }, "defaultLockdownState" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "doorLockdownStateMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "physicalAccess" : { "$ref" : "#/components/schemas/LockdownPhysicalAccessType" }, "scopeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "testPlan" : { "$ref" : "#/components/schemas/LockdownTestPlanType" }, "type" : { "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OrgPaneLinkType" : { "type" : "object", "nullable" : true, "properties" : { "description" : { "type" : "string", "nullable" : true }, "label" : { "type" : "string", "nullable" : true }, "paneId" : { "type" : "string", "nullable" : true }, "permissionGroupUuids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "tier" : { "$ref" : "#/components/schemas/LicenseEnum" }, "userUuids" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true } } }, "OrgSamlSettingsType" : { "type" : "object", "description" : "List of SAML settings to update", "properties" : { "addUsersOnRoleMismatch" : { "type" : "boolean", "nullable" : true }, "allowIdpSessionReuse" : { "type" : "boolean", "nullable" : true }, "domain" : { "$ref" : "#/components/schemas/RhombusSamlDomainEnum" }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledForRhombusKey" : { "type" : "boolean", "nullable" : true }, "idpMetaDataXml" : { "type" : "string", "nullable" : true }, "justInTimeAccountProvisioningEnabled" : { "type" : "boolean", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "registrationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "rhombusKeyAppSettings" : { "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" }, "teamName" : { "type" : "string", "nullable" : true } } }, "OrgType" : { "type" : "object", "description" : "Organization information to update", "properties" : { "accountOwnerEmail" : { "type" : "string", "nullable" : true }, "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "firmwareUpdateSettings" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" }, "itemizedInvoice" : { "type" : "boolean", "nullable" : true }, "mfaEnabled" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "newCameraFramerateMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraResolutionMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraSegmentMaxBytesMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraVideoTargetQualityMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "notificationSettings" : { "$ref" : "#/components/schemas/NotificationSettingsType" }, "partnerAccessAllowedUntil" : { "type" : "integer", "format" : "int32", "nullable" : true }, "planType" : { "$ref" : "#/components/schemas/PlanTypeEnum" }, "postalCode" : { "type" : "string", "nullable" : true }, "rbacSettings" : { "$ref" : "#/components/schemas/RBACSettingsType" }, "samlSettings" : { "$ref" : "#/components/schemas/SAMLSettingsType" }, "subscriptionEndDate" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subscriptionStatus" : { "$ref" : "#/components/schemas/SubscriptionStatusEnum" }, "subscriptionType" : { "$ref" : "#/components/schemas/SubscriptionTypeEnum" }, "supportAccessAllowedUntil" : { "type" : "integer", "format" : "int32", "nullable" : true }, "teamName" : { "type" : "string", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/OrgTypeEnum" }, "uapSettings" : { "$ref" : "#/components/schemas/UAPSettingsType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OrgTypeEnum" : { "type" : "string", "enum" : [ "PARTNER", "CUSTOMER", "UNKNOWN" ] }, "OrgV2Type" : { "type" : "object", "description" : "List of Rhombus organizations the user has access to", "nullable" : true, "properties" : { "accountBillingContactEmail" : { "type" : "string", "nullable" : true }, "accountOwnerEmail" : { "type" : "string", "nullable" : true }, "accountTechnicalContactEmail" : { "type" : "string", "nullable" : true }, "accountTechnicalContacts" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "address1" : { "type" : "string", "nullable" : true }, "address2" : { "type" : "string", "nullable" : true }, "allowedLoginIpRanges" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "applyMobileSessionLimit" : { "type" : "boolean", "nullable" : true }, "audioAnalysisEnabled" : { "type" : "boolean", "nullable" : true }, "audioRecordingEnabled" : { "type" : "boolean", "nullable" : true }, "bandwidthReportsDisabled" : { "type" : "boolean", "nullable" : true }, "companyLogoUrl" : { "type" : "string", "nullable" : true }, "companyLogoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "connectivityBatchWindowSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, "countryCode" : { "type" : "string", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "criticalStatusEnabled" : { "type" : "boolean", "nullable" : true }, "dataRetentionSettings" : { "$ref" : "#/components/schemas/DataRetentionSettingsType" }, "defaultPlayerViewLiveType" : { "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" }, "deleted" : { "type" : "boolean", "nullable" : true }, "deletedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "developmentPartnerOrg" : { "type" : "boolean", "nullable" : true }, "firmwareUpdateSettings" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" }, "firmwareUpdateSettingsOverrides" : { "type" : "array", "description" : "Overrides default firmware update settings.", "items" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" }, "nullable" : true }, "inactivityTimeout" : { "type" : "integer", "format" : "int32", "nullable" : true }, "itemizedInvoice" : { "type" : "boolean", "nullable" : true }, "keypadLogoUrl" : { "type" : "string", "nullable" : true }, "keypadLogoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "llmUsageEnabled" : { "type" : "boolean", "nullable" : true }, "managedClientPolicy" : { "$ref" : "#/components/schemas/ManagedClientPolicyType" }, "managingPartnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "maxAllowedSegmentMaxBytesMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "mfaEnabled" : { "type" : "boolean", "nullable" : true }, "mobileSessionLimitInDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, "motionGridDisabled" : { "type" : "boolean", "nullable" : true }, "motionLightweightDisabled" : { "type" : "boolean", "nullable" : true }, "mspDesignation" : { "$ref" : "#/components/schemas/MspDesignationType" }, "name" : { "type" : "string", "nullable" : true }, "newCameraFramerateMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraResolutionMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraSegmentMaxBytesMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraVideoTargetQualityMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "newCameraZeroMotionVideoQualityMap" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32", "nullable" : true }, "nullable" : true }, "notifyForHardwareFailureTickets" : { "type" : "boolean", "nullable" : true }, "paneLinks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrgPaneLinkType" }, "nullable" : true }, "partnerAccessAllowedUntil" : { "type" : "integer", "format" : "int32", "nullable" : true }, "postalCode" : { "type" : "string", "nullable" : true }, "rhombusKeyLogoUrl" : { "type" : "string", "nullable" : true }, "rhombusKeyLogoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "salesforceAccountId" : { "type" : "string", "nullable" : true }, "shareAiTrainingMediaWithRhombus" : { "type" : "boolean", "nullable" : true }, "subscriptionEndDate" : { "type" : "integer", "format" : "int64", "nullable" : true }, "subscriptionStatus" : { "$ref" : "#/components/schemas/SubscriptionStatusEnum" }, "subscriptionType" : { "$ref" : "#/components/schemas/SubscriptionTypeEnum" }, "supportAccessAllowedUntil" : { "type" : "integer", "format" : "int32", "nullable" : true }, "tenantUrl" : { "type" : "string", "nullable" : true }, "thumbstripDisabled" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/OrgTypeEnum" }, "uapSettings" : { "$ref" : "#/components/schemas/UAPSettingsType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "v3AuthNumDaysSkip2FAForTrustedDevices" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "Org_ClaimActivationTokenWSRequest" : { "type" : "object", "properties" : { "activationToken" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_ClaimActivationTokenWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_ClaimShipmentRegistrationTokenWSRequest" : { "type" : "object", "properties" : { "claimList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Org_DeviceRegistrationClaimType" }, "nullable" : true }, "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_ClaimShipmentRegistrationTokenWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_CreateOrUpdateHealthNotificationRuleWSRequest" : { "type" : "object", "description" : "Request object for creating or updating a health notification rule.", "properties" : { "rule" : { "$ref" : "#/components/schemas/HealthNotificationRuleType" } } }, "Org_CreateOrUpdateHealthNotificationRuleWSResponse" : { "type" : "object", "description" : "Response object for creating or updating a health notification rule.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rule" : { "$ref" : "#/components/schemas/HealthNotificationRuleType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_CreatePendingRegistrationRequest" : { "type" : "object", "description" : "Request object for creating pending hardware registration.", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the hardware device", "example" : "RH123456789", "nullable" : true }, "wifiPsk" : { "type" : "array", "description" : "WiFi pre-shared key for the device", "items" : { "type" : "string", "format" : "byte", "description" : "WiFi pre-shared key for the device", "nullable" : true }, "nullable" : true }, "wifiSsid" : { "type" : "string", "description" : "WiFi SSID for the device", "example" : "Office_WiFi", "nullable" : true } }, "required" : [ "orgUuid", "serialNumber" ] }, "Org_CreatePendingRegistrationResponse" : { "type" : "object", "description" : "Response object for creating pending hardware registration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeleteCloudArchivingConfigWSRequest" : { "type" : "object", "description" : "Request object for deleting cloud archiving configuration.", "properties" : { "scope" : { "$ref" : "#/components/schemas/DeviceTargetScopeEnum" }, "targetUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_DeleteCloudArchivingConfigWSResponse" : { "type" : "object", "description" : "Response object for deleting cloud archiving configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeleteHealthNotificationRuleWSRequest" : { "type" : "object", "description" : "Request object for deleting a health notification rule.", "properties" : { "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_DeleteHealthNotificationRuleWSResponse" : { "type" : "object", "description" : "Response object for deleting a health notification rule.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeleteKeypadLogoWSRequest" : { "type" : "object", "description" : "Request object for deleting keypad logo." }, "Org_DeleteKeypadLogoWSResponse" : { "type" : "object", "description" : "Response object for deleting keypad logo.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeleteRhombusKeyLogoWSRequest" : { "type" : "object", "description" : "Request object for deleting Rhombus Key logo.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeleteRhombusKeyLogoWSResponse" : { "type" : "object", "description" : "Response object for deleting Rhombus Key logo.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_DeviceRegistrationClaimType" : { "type" : "object", "properties" : { "deviceName" : { "type" : "string", "nullable" : true }, "hardwareUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_FindAllHardwareWithPendingRegistrationRequest" : { "type" : "object" }, "Org_FindAllHardwareWithPendingRegistrationResponse" : { "type" : "object", "properties" : { "hardwareList" : { "type" : "array", "deprecated" : true, "description" : "Use hardwareWithPendingRegistrationInfoList instead", "items" : { "$ref" : "#/components/schemas/HardwareType" }, "nullable" : true }, "hardwareWithPendingRegistrationInfoList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Org_HardwareWithPendingRegistrationInfoType" }, "nullable" : true } } }, "Org_FindHardwareAvailableForPendingRegistrationRequest" : { "type" : "object" }, "Org_FindHardwareAvailableForPendingRegistrationResponse" : { "type" : "object", "properties" : { "hardwareList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HardwareType" }, "nullable" : true } } }, "Org_FindIfTeamNameAvailableRequest" : { "type" : "object", "description" : "Request object for checking if a team name is available.", "properties" : { "teamName" : { "type" : "string", "description" : "Team name to check availability for", "example" : "Engineering Team", "nullable" : true } } }, "Org_FindIfTeamNameAvailableResponse" : { "type" : "object", "description" : "Response object indicating if a team name is available.", "properties" : { "available" : { "type" : "boolean", "description" : "Whether the team name is available", "example" : true, "nullable" : true } } }, "Org_FindSCIMSettingsForOrgWSRequest" : { "type" : "object", "description" : "Request object for finding SCIM settings for organization." }, "Org_FindSCIMSettingsForOrgWSResponse" : { "type" : "object", "description" : "Response object containing SCIM settings for organization.", "properties" : { "scimSettings" : { "$ref" : "#/components/schemas/SCIMSettingsType" } } }, "Org_GenerateFederatedSessionTokenRequest" : { "type" : "object", "description" : "Request object for generating a federated session token.", "properties" : { "deviceUUid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "domain" : { "type" : "string", "description" : "Optional. The origin that is allowed to use the federated token, specified as a fully qualified URL (scheme and host, plus a port if non-default). On the browser API the value is applied as a CORS allowed-origin, and must match the browser's Origin exactly. For media requests, which are not governed by CORS, the request's Referer is parsed and compared against this value on origin (scheme, host and port) — so the Referer may carry a path and query and still match. Omit the field to leave the token unrestricted, which is required for clients that cannot send a Referer, such as native and on-prem players. This restricts where a token can be used from a browser; it is not a substitute for treating the token as a bearer credential. Both Origin and Referer are supplied by the client, so a non-browser caller holding the token can send either value at will. Use a short durationSec, and deviceUUid where the token only needs one camera's media, to limit a token that has been extracted.", "example" : "https://app.example.com", "nullable" : true }, "durationSec" : { "type" : "integer", "format" : "int32", "description" : "Duration of the federated session token in seconds", "example" : 3600, "nullable" : true } } }, "Org_GenerateFederatedSessionTokenResponse" : { "type" : "object", "description" : "Response object containing the generated federated session token.", "properties" : { "federatedSessionToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_GetAwsIntCloudformationFileRequest" : { "type" : "object", "description" : "Request object for getting AWS CloudFormation file." }, "Org_GetAwsIntCloudformationFileResponse" : { "type" : "object", "description" : "Response object containing AWS CloudFormation file.", "properties" : { "fileBase64" : { "type" : "string", "description" : "Base64 encoded CloudFormation file content", "example" : "UEsDBBQAAAAIAA...", "nullable" : true } } }, "Org_GetClientOrgWSRequest" : { "type" : "object", "description" : "Request object for getting client organization details.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_GetClientOrgWSResponse" : { "type" : "object", "description" : "Response object containing client organization details.", "properties" : { "featureFlags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of feature flags for the client organization", "nullable" : true }, "description" : "Map of feature flags for the client organization", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgV2Type" }, "partnerOrgPermissionGroup" : { "$ref" : "#/components/schemas/UserPermissionGroupType" } } }, "Org_GetCloudArchivingConfigsWSRequest" : { "type" : "object", "description" : "Request object for getting cloud archiving configurations." }, "Org_GetCloudArchivingConfigsWSResponse" : { "type" : "object", "description" : "Response object containing cloud archiving configurations.", "properties" : { "archivingConfigs" : { "type" : "array", "description" : "List of cloud archiving configurations", "items" : { "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetDeviceFlagsWSRequest" : { "type" : "object", "description" : "Request object for getting device flags.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_GetDeviceFlagsWSResponse" : { "type" : "object", "description" : "Response object containing device flags.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of device flags", "nullable" : true }, "description" : "Map of device flags", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetFeaturesWSRequest" : { "type" : "object", "description" : "Request object for getting organization features." }, "Org_GetFeaturesWSResponse" : { "type" : "object", "description" : "Response object containing organization feature flags.", "properties" : { "behaviorDetection" : { "type" : "boolean", "description" : "Whether behavior detection is enabled", "example" : false, "nullable" : true }, "cloudArchiving" : { "type" : "boolean", "description" : "Whether cloud archiving is enabled", "example" : false, "nullable" : true }, "engagementCounting" : { "type" : "boolean", "description" : "Whether engagement counting is enabled", "example" : false, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "faceCounting" : { "type" : "boolean", "description" : "Whether face counting is enabled", "example" : false, "nullable" : true }, "faceCountingNonUnique" : { "type" : "boolean", "description" : "Whether non-unique face counting is enabled", "example" : false, "nullable" : true }, "faceRecognition" : { "type" : "boolean", "description" : "Whether face recognition is enabled", "example" : false, "nullable" : true }, "licensePlateRecognition" : { "type" : "boolean", "description" : "Whether license plate recognition is enabled", "example" : false, "nullable" : true }, "peopleCounting" : { "type" : "boolean", "description" : "Whether people counting is enabled", "example" : false, "nullable" : true }, "ppeDetection" : { "type" : "boolean", "description" : "Whether PPE detection is enabled", "example" : false, "nullable" : true }, "rulesEngine" : { "type" : "boolean", "description" : "Whether rules engine is enabled (deprecated)", "example" : false, "nullable" : true }, "vehicleCounting" : { "type" : "boolean", "description" : "Whether vehicle counting is enabled", "example" : false, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetHealthNotificationRulesWSRequest" : { "type" : "object", "description" : "Request object for getting health notification rules." }, "Org_GetHealthNotificationRulesWSResponse" : { "type" : "object", "description" : "Response object containing health notification rules for the organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "rules" : { "type" : "array", "description" : "List of health notification rules", "items" : { "$ref" : "#/components/schemas/HealthNotificationRuleType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetLocationFlagsWSRequest" : { "type" : "object", "description" : "Request object for getting location flags." }, "Org_GetLocationFlagsWSResponse" : { "type" : "object", "description" : "Response object containing location flags for all locations.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "flagsMap" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of location UUIDs to their flags", "nullable" : true }, "description" : "Map of location UUIDs to their flags", "nullable" : true }, "description" : "Map of location UUIDs to their flags", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetOrgIntegrationsWSRequest" : { "type" : "object", "description" : "Request object for getting organization integrations (deprecated, use integration package)." }, "Org_GetOrgIntegrationsWSResponse" : { "type" : "object", "description" : "Response object containing organization integrations (deprecated, use integration package).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "orgIntegrations" : { "$ref" : "#/components/schemas/OrgIntegrationsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetOrgNotificationTemplateV2WSResponse" : { "type" : "object", "description" : "Response object containing organization notification template V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "notificationSettings" : { "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetOrgNotificationTemplateWSRequest" : { "type" : "object", "description" : "Request object for getting organization notification template." }, "Org_GetOrgNotificationTemplateWSResponse" : { "type" : "object", "description" : "Response object containing organization notification template.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "notificationSettings" : { "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetOrgV2WSRequest" : { "type" : "object", "description" : "Request object for getting organization details V2." }, "Org_GetOrgV2WSResponse" : { "type" : "object", "description" : "Response object containing organization details V2 with camera configuration options.", "properties" : { "cameraConfigDefaults" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationDefault" }, "description" : "Map of hardware variations to default video configurations", "nullable" : true }, "cameraConfigOptions" : { "type" : "object", "additionalProperties" : { "type" : "array", "description" : "Map of hardware variations to available video configuration options", "items" : { "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationOption" }, "nullable" : true }, "description" : "Map of hardware variations to available video configuration options", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "featureFlags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of feature flags for the organization", "nullable" : true }, "description" : "Map of feature flags for the organization", "nullable" : true }, "managingPartnerName" : { "type" : "string", "description" : "MSP initiative: name of the MSP that manages this org (org.managingPartnerOrgUuid), when managed.", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgV2Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetOrgWSRequest" : { "type" : "object", "description" : "Request object for getting organization details (deprecated)." }, "Org_GetOrgWSResponse" : { "type" : "object", "description" : "Response object containing organization details (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "featureFlags" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of feature flags for the organization", "nullable" : true }, "description" : "Map of feature flags for the organization", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetSAMLSettingsV2WSRequest" : { "type" : "object", "description" : "Request object for getting SAML settings V2." }, "Org_GetSAMLSettingsV2WSResponse" : { "type" : "object", "description" : "Response object containing SAML settings V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "samlSettings" : { "type" : "array", "description" : "List of SAML settings for the organization", "items" : { "$ref" : "#/components/schemas/OrgSamlSettingsType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetSAMLSettingsWSRequest" : { "type" : "object", "description" : "Request object for getting SAML settings (deprecated)." }, "Org_GetSAMLSettingsWSResponse" : { "type" : "object", "description" : "Response object containing SAML settings (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "samlSettings" : { "$ref" : "#/components/schemas/OrgSamlSettingsType" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_GetScimDisplayInfoResponse" : { "type" : "object", "description" : "Response object containing SCIM display information.", "properties" : { "azureScimEndpointUrl" : { "type" : "string", "description" : "Azure SCIM endpoint URL", "example" : "https://api.rhombussystems.com/scim/v2/azure", "nullable" : true }, "scimEndpointUrl" : { "type" : "string", "description" : "SCIM endpoint URL", "example" : "https://api.rhombussystems.com/scim/v2", "nullable" : true } } }, "Org_GetTemporaryOrgTokenWSRequest" : { "type" : "object", "description" : "Request object for getting temporary organization token." }, "Org_HardwareWithPendingRegistrationInfoType" : { "type" : "object", "properties" : { "hardware" : { "$ref" : "#/components/schemas/HardwareType" }, "hwUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "pendingRegistrationInfo" : { "$ref" : "#/components/schemas/Org_PendingRegistrationInfoType" } } }, "Org_PeekShipmentRegistrationTokenWSRequest" : { "type" : "object", "properties" : { "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_PeekShipmentRegistrationTokenWSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "hardwareUuidList" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_PendingRegistrationInfoType" : { "type" : "object", "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_RemovePendingRegistrationRequest" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "nullable" : true } } }, "Org_RemovePendingRegistrationResponse" : { "type" : "object" }, "Org_RevokeSCIMAccessForOrgWSRequest" : { "type" : "object", "description" : "Request object for revoking SCIM access for organization." }, "Org_RevokeSCIMAccessForOrgWSResponse" : { "type" : "object", "description" : "Response object for revoking SCIM access for organization." }, "Org_SetFlagWSRequest" : { "type" : "object", "description" : "Request object for setting organization flags.", "properties" : { "flagName" : { "type" : "string", "description" : "Name of the flag to set", "example" : "feature_enabled", "nullable" : true }, "flagValue" : { "type" : "string", "description" : "Value of the flag to set", "example" : "true", "nullable" : true } } }, "Org_SetFlagWSResponse" : { "type" : "object", "description" : "Response object for setting organization flags.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_SetupSCIMAccessForOrgWSRequest" : { "type" : "object", "description" : "Request object for setting up SCIM access for organization.", "properties" : { "addUsersOnRoleMismatch" : { "type" : "boolean", "description" : "Whether to add users on role mismatch", "example" : false, "nullable" : true }, "rhombusKeyAppSettings" : { "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" }, "sendWelcomeEmailToNewRhombusKeyUsers" : { "type" : "boolean", "description" : "Whether to send welcome email to new Rhombus Key users", "example" : true, "nullable" : true }, "sendWelcomeEmailToNewUsers" : { "type" : "boolean", "description" : "Whether to send welcome email to new users", "example" : true, "nullable" : true } } }, "Org_SetupSCIMAccessForOrgWSResponse" : { "type" : "object", "description" : "Response object for setting up SCIM access for organization.", "properties" : { "scimAccessAlreadySetupFailure" : { "type" : "boolean", "nullable" : true }, "token" : { "type" : "string", "nullable" : true } } }, "Org_UpdateAiTrainingSettingsWSRequest" : { "type" : "object", "description" : "Request object for updating AI training settings.", "properties" : { "shareAiTrainingMediaWithRhombus" : { "type" : "boolean", "description" : "Whether to share AI training media with Rhombus", "example" : false, "nullable" : true } } }, "Org_UpdateAiTrainingSettingsWSResponse" : { "type" : "object", "description" : "Response object for updating AI training settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateCloudArchivingConfigWSRequest" : { "type" : "object", "description" : "Request object for updating cloud archiving configuration.", "properties" : { "archivingConfig" : { "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" } } }, "Org_UpdateCloudArchivingConfigWSResponse" : { "type" : "object", "description" : "Response object for updating cloud archiving configuration.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateDataRetentionSettingsWSRequest" : { "type" : "object", "description" : "Request object for updating org data retention settings for face and license plate events.", "properties" : { "dataRetentionSettings" : { "$ref" : "#/components/schemas/DataRetentionSettingsType" } } }, "Org_UpdateDataRetentionSettingsWSResponse" : { "type" : "object", "description" : "Response object for updating org data retention settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgV2Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateFirmwareSettingsWSRequest" : { "type" : "object", "description" : "Request object for updating firmware settings.", "properties" : { "firmwareSettings" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" }, "firmwareUpdateSettings" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" }, "firmwareUpdateSettingsOverrides" : { "type" : "array", "description" : "Overrides default firmware update settings.", "items" : { "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" }, "nullable" : true } } }, "Org_UpdateFirmwareSettingsWSResponse" : { "type" : "object", "description" : "Response object for updating firmware settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateGeneralSettingsWSRequest" : { "type" : "object", "description" : "Request object for updating general organization settings.", "properties" : { "accountBillingContactEmail" : { "type" : "string", "description" : "Email of the account billing contact", "example" : "billing@acme.com", "nullable" : true }, "accountOwnerEmail" : { "type" : "string", "description" : "Email of the account owner", "example" : "owner@acme.com", "nullable" : true }, "accountTechnicalContactEmail" : { "type" : "string", "description" : "Email of the account technical contact", "example" : "tech@acme.com", "nullable" : true }, "accountTechnicalContacts" : { "type" : "array", "description" : "List of account technical contact emails", "items" : { "type" : "string", "description" : "List of account technical contact emails", "nullable" : true }, "nullable" : true }, "connectivityBatchWindowSecs" : { "type" : "integer", "format" : "int32", "description" : "Window in seconds over which device connectivity notifications are batched into a single digest; null or 0 disables batching", "example" : 300, "nullable" : true }, "defaultPlayerViewLiveType" : { "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" }, "inactivityTimeout" : { "type" : "integer", "format" : "int32", "description" : "Inactivity timeout in minutes", "example" : 30, "nullable" : true }, "mobileSessionLimitInDays" : { "type" : "integer", "format" : "int32", "description" : "Mobile session length in days (1-365); sessions older than this are invalidated and the mobile apps re-authenticate", "example" : 30, "nullable" : true }, "name" : { "type" : "string", "description" : "Name of the organization", "example" : "Acme Corporation", "nullable" : true }, "uapSettings" : { "$ref" : "#/components/schemas/UAPSettingsType" } } }, "Org_UpdateGeneralSettingsWSResponse" : { "type" : "object", "description" : "Response object for updating general organization settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateLoginIpAllowlistWSRequest" : { "type" : "object", "description" : "Request object for updating the org-wide login IP allowlist.", "properties" : { "allowedLoginIpRanges" : { "type" : "array", "description" : "IP addresses / CIDR ranges that users flagged with restrictToAllowedLoginIps may use the web console from. An empty list clears the allowlist (and lifts the restriction until ranges are configured again).", "example" : [ "203.0.113.5", "198.51.100.0/24" ], "items" : { "type" : "string", "description" : "IP addresses / CIDR ranges that users flagged with restrictToAllowedLoginIps may use the web console from. An empty list clears the allowlist (and lifts the restriction until ranges are configured again).", "example" : "[\"203.0.113.5\",\"198.51.100.0/24\"]", "nullable" : true }, "nullable" : true } } }, "Org_UpdateLoginIpAllowlistWSResponse" : { "type" : "object", "description" : "Response object for updating the org-wide login IP allowlist.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgV2Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateMFASettingsWSRequest" : { "type" : "object", "description" : "Request object for updating MFA settings.", "properties" : { "mfaEnabled" : { "type" : "boolean", "description" : "Whether MFA is enabled for the organization", "example" : true, "nullable" : true }, "v3AuthNumDaysSkip2FAForTrustedDevices" : { "type" : "integer", "format" : "int32", "description" : "Number of days to skip 2FA for trusted devices (< 0 = forever, 0 = always require 2FA, > 0 = days to skip)", "example" : 30, "nullable" : true } } }, "Org_UpdateMFASettingsWSResponse" : { "type" : "object", "description" : "Response object for updating MFA settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "org" : { "$ref" : "#/components/schemas/OrgV2Type" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgAudioAnalysisPolicyWSRequest" : { "type" : "object", "description" : "Request object for updating organization audio analysis policy.", "properties" : { "audioAnalysisEnabled" : { "type" : "boolean", "description" : "Whether audio analysis is enabled for the organization", "example" : true, "nullable" : true } } }, "Org_UpdateOrgAudioAnalysisPolicyWSResponse" : { "type" : "object", "description" : "Response object for updating organization audio analysis policy.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgAudioRecordingPolicyWSRequest" : { "type" : "object", "description" : "Request object for updating organization audio recording policy.", "properties" : { "audioRecordingEnabled" : { "type" : "boolean", "description" : "Whether audio recording is enabled for the organization", "example" : true, "nullable" : true } } }, "Org_UpdateOrgAudioRecordingPolicyWSResponse" : { "type" : "object", "description" : "Response object for updating organization audio recording policy.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgIntegrationsWSRequest" : { "type" : "object", "description" : "Request object for updating organization integrations (deprecated, use integration package).", "properties" : { "orgIntegrations" : { "$ref" : "#/components/schemas/OrgIntegrationsType" } } }, "Org_UpdateOrgIntegrationsWSResponse" : { "type" : "object", "description" : "Response object for updating organization integrations (deprecated, use integration package).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgLLMUsagePolicyWSRequest" : { "type" : "object", "description" : "Request object for updating organization LLM usage opt-in policy.", "properties" : { "llmUsageEnabled" : { "type" : "boolean", "description" : "Whether the org is opting in to use LLMs", "example" : true, "nullable" : true } } }, "Org_UpdateOrgLLMUsagePolicyWSResponse" : { "type" : "object", "description" : "Response object for updating organization LLM usage opt-in policy.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgNotificationTemplateV2WSRequest" : { "type" : "object", "description" : "Request object for updating organization notification template V2.", "properties" : { "summaryEmailEnabled" : { "type" : "boolean", "description" : "Whether summary email is enabled", "example" : true, "nullable" : true }, "templateUpdate" : { "$ref" : "#/components/schemas/UserNotificationSelectiveUpdateV2" } } }, "Org_UpdateOrgNotificationTemplateV2WSResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgNotificationTemplateWSRequest" : { "type" : "object", "description" : "Request object for updating organization notification template.", "properties" : { "notificationIntervalsV2" : { "type" : "array", "description" : "List of notification intervals V2", "items" : { "$ref" : "#/components/schemas/NotificationIntervalV2Type" }, "nullable" : true }, "summaryEmailEnabled" : { "type" : "boolean", "description" : "Whether summary email is enabled", "example" : true, "nullable" : true } } }, "Org_UpdateOrgNotificationTemplateWSResponse" : { "type" : "object", "description" : "Response object for updating organization notification template.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateOrgWSRequest" : { "type" : "object", "description" : "Request object for updating organization details (deprecated).", "properties" : { "org" : { "$ref" : "#/components/schemas/OrgType" } } }, "Org_UpdateOrgWSResponse" : { "type" : "object", "description" : "Response object for updating organization details (deprecated).", "properties" : { "samlEntityIdUniquenessConstraintFailure" : { "type" : "boolean", "nullable" : true }, "teamNameNotAssignedFailure" : { "type" : "boolean", "nullable" : true }, "teamNameUniquenessConstraintFailure" : { "type" : "boolean", "nullable" : true } } }, "Org_UpdatePaneLinksWSRequest" : { "type" : "object", "description" : "Request object for setting which PANE apps this organization links.", "properties" : { "paneLinks" : { "type" : "array", "description" : "The complete set of PANE apps this organization links, replacing any current set. An empty list removes them all.", "items" : { "$ref" : "#/components/schemas/OrgPaneLinkType" }, "nullable" : true } } }, "Org_UpdatePaneLinksWSResponse" : { "type" : "object", "description" : "Response object for setting which PANE apps this organization links.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdatePendingRegistrationRequest" : { "type" : "object", "properties" : { "hardwareUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Org_UpdatePendingRegistrationResponse" : { "type" : "object", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateSAMLSettingsV2WSRequest" : { "type" : "object", "description" : "Request object for updating SAML settings V2.", "properties" : { "samlSettings" : { "type" : "array", "description" : "List of SAML settings to update", "items" : { "$ref" : "#/components/schemas/OrgSamlSettingsType" }, "nullable" : true } } }, "Org_UpdateSAMLSettingsV2WSResponse" : { "type" : "object", "description" : "Response object for updating SAML settings V2.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateSAMLSettingsWSRequest" : { "type" : "object", "description" : "Request object for updating SAML settings (deprecated).", "properties" : { "samlSettings" : { "$ref" : "#/components/schemas/OrgSamlSettingsType" } } }, "Org_UpdateSAMLSettingsWSResponse" : { "type" : "object", "description" : "Response object for updating SAML settings (deprecated).", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Org_UpdateSCIMSettingsForOrgWSRequest" : { "type" : "object", "description" : "Request object for updating SCIM settings for organization.", "properties" : { "addUsersOnRoleMismatch" : { "type" : "boolean", "description" : "Whether to add users on role mismatch", "example" : false, "nullable" : true }, "rhombusKeyAppSettings" : { "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" }, "sendWelcomeEmailToNewRhombusKeyUsers" : { "type" : "boolean", "description" : "Whether to send welcome email to new Rhombus Key users", "example" : true, "nullable" : true }, "sendWelcomeEmailToNewUsers" : { "type" : "boolean", "description" : "Whether to send welcome email to new users", "example" : true, "nullable" : true } } }, "Org_UpdateSCIMSettingsForOrgWSResponse" : { "type" : "object", "description" : "Response object for updating SCIM settings for organization.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "OsdpDoorReaderType" : { "type" : "object", "properties" : { "allowUnencrypted" : { "type" : "boolean", "nullable" : true }, "baseType" : { "$ref" : "#/components/schemas/ComponentBaseEnumType" }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "disableCardReader" : { "type" : "boolean", "nullable" : true }, "disableKeypad" : { "type" : "boolean", "nullable" : true }, "disableWaveToUnlock" : { "type" : "boolean", "nullable" : true }, "disposition" : { "$ref" : "#/components/schemas/ReaderDispositionEnum" }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "osdpAddress" : { "type" : "integer", "format" : "int32", "nullable" : true }, "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "port" : { "$ref" : "#/components/schemas/OsdpReaderPortType" }, "portImmutable" : { "type" : "boolean", "nullable" : true }, "readerType" : { "$ref" : "#/components/schemas/DoorReaderEnumType" }, "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEnumType" }, "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "OsdpPhysicalPortEnumType" : { "type" : "string", "enum" : [ "RS485" ] }, "OsdpReaderPortType" : { "type" : "object", "properties" : { "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, "portType" : { "$ref" : "#/components/schemas/OsdpPhysicalPortEnumType" } } }, "OutgoingShipmentInfoType" : { "type" : "object", "description" : "Outgoing shipment information (deprecated)", "properties" : { "buyer" : { "$ref" : "#/components/schemas/Buyer" }, "consignee" : { "$ref" : "#/components/schemas/Consignee" }, "depositorOrderNumber" : { "type" : "string", "nullable" : true }, "freight" : { "$ref" : "#/components/schemas/Freight" }, "interchangeControlNumber" : { "type" : "string", "nullable" : true }, "product" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Product" }, "nullable" : true }, "purchaseOrderNumber" : { "type" : "string", "nullable" : true }, "shipment" : { "$ref" : "#/components/schemas/Shipment" }, "shipper" : { "$ref" : "#/components/schemas/Shipper" } } }, "PagerDutySettings" : { "type" : "object", "properties" : { "allLocationIntegrationKeys" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "enabled" : { "type" : "boolean", "nullable" : true }, "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "enablingUser" : { "type" : "string", "nullable" : true }, "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "integrationKey" : { "type" : "string", "nullable" : true }, "locationToIntegrationKeysMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "nullable" : true } } }, "PaginateRequest" : { "type" : "object", "description" : "Request object for retrieving a resource with optional pagination.", "properties" : { "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, "PaneCatalogItem" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" } } } ], "nullable" : true, "properties" : { "durationMonths" : { "type" : "integer", "format" : "int32", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" } } }, "PaneLicenseStatusReasonEnum" : { "type" : "string", "description" : "LICENSED, or why the pane is not licensed: NO_LICENSE, EXPIRED, INVALID_STATE", "enum" : [ "LICENSED", "NO_LICENSE", "EXPIRED", "INVALID_STATE" ] }, "PaneLicenseType" : { "type" : "object", "description" : "List of PANE app licenses in the client organization", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "createdOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "licenseToUnassignEmailState" : { "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" }, "licenseType" : { "$ref" : "#/components/schemas/LicenseEnum" }, "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "paneId" : { "type" : "string", "nullable" : true }, "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "productType" : { "$ref" : "#/components/schemas/ProductTypeEnum" }, "state" : { "$ref" : "#/components/schemas/LicenseStateEnum" }, "trial" : { "type" : "boolean", "nullable" : true }, "updatedOn" : { "type" : "string", "format" : "date-time", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "PaneType" : { "type" : "object", "description" : "PANE apps Rhombus has made available to the organization, with each one's tier", "properties" : { "description" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "paneId" : { "type" : "string", "nullable" : true }, "tier" : { "$ref" : "#/components/schemas/LicenseEnum" }, "title" : { "type" : "string", "nullable" : true } } }, "PanelType" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "name" : { "type" : "string", "nullable" : true } } }, "PanicButtonEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "newSupervisionState" : { "$ref" : "#/components/schemas/SupervisionStateEnumType" } } } ], "nullable" : true, "properties" : { "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "correlationId" : { "type" : "string", "nullable" : true }, "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "subLocationsHierarchyKey" : { "type" : "string", "format" : "SubLocationsHierarchyKey", "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ParPOSType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "nullable" : true }, "locationTokenMap" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "serverUrl" : { "type" : "string", "nullable" : true } } } ], "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, "integration" : { "$ref" : "#/components/schemas/IntegrationEnum" }, "integrationAuditMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "ParameterizedHeader" : { "type" : "object", "nullable" : true, "properties" : { "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, "value" : { "type" : "string", "nullable" : true } } }, "ParseRulePromptRequest" : { "type" : "object", "properties" : { "catalog" : { "$ref" : "#/components/schemas/RulePromptCatalog" }, "orgUuid" : { "type" : "string", "nullable" : true }, "source" : { "type" : "string", "nullable" : true }, "timezone" : { "type" : "string", "nullable" : true }, "turns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromptTurn" }, "nullable" : true } } }, "ParseRulePromptResponse" : { "type" : "object", "properties" : { "assistantText" : { "type" : "string", "nullable" : true }, "draft" : { "$ref" : "#/components/schemas/RulePromptDraft" }, "error" : { "type" : "boolean", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "options" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RulePromptClarificationOption" }, "nullable" : true }, "question" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string", "nullable" : true } } }, "PartnerFunctionalityEnum" : { "type" : "string", "enum" : [ "CREATE_CLIENT", "DELETE_CLIENT", "DEAL_ADMINISTRATION", "REMOTE_REGISTER_DEVICE", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "MSP_ADMINISTRATION", "CLIP_MANAGEMENT", "UNKNOWN" ] }, "PartnerNotificationClientSection" : { "type" : "object", "properties" : { "clientUuids" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "rows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartnerNotificationClientSectionRow" }, "nullable" : true } } }, "PartnerNotificationClientSectionRow" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "days" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" }, "nullable" : true, "uniqueItems" : true }, "diagnostics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DiagnosticActivityEnum" }, "nullable" : true, "uniqueItems" : true }, "interval" : { "$ref" : "#/components/schemas/MinuteOfDayIntervalType" }, "mediums" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEnumType" }, "nullable" : true, "uniqueItems" : true } } }, "PartnerNotificationSettingsV2" : { "type" : "object", "properties" : { "allClientsSelected" : { "type" : "boolean", "nullable" : true }, "clientNotificationIntervalsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartnerNotificationClientSection" }, "nullable" : true }, "nullable" : true }, "notificationIntervalsForAllClients" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartnerNotificationClientSection" }, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "smsNotificationIncludesLinks" : { "type" : "boolean", "nullable" : true }, "smsPhoneNumbers" : { "type" : "array", "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, "summaryEmailEnabled" : { "type" : "boolean", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "PartnerOrgClaimKey" : { "type" : "object", "description" : "CREATED (not yet claimed) keys for the partner, as getClaimKeysForPartnerOrg returns them.", "properties" : { "accountAdminId" : { "type" : "string", "nullable" : true }, "accountName" : { "type" : "string", "nullable" : true }, "claimKeyUuid" : { "type" : "string", "nullable" : true }, "contractEndDate" : { "type" : "string", "nullable" : true }, "contractStartDate" : { "type" : "string", "nullable" : true }, "createdDate" : { "type" : "string", "nullable" : true }, "externalUuid" : { "type" : "string", "nullable" : true }, "poNumber" : { "type" : "string", "nullable" : true } } }, "PartnerPermissionEnum" : { "type" : "string", "enum" : [ "DEFAULT", "CUSTOM" ] }, "PartnerPermissionType" : { "type" : "object", "description" : "List of partner permissions", "properties" : { "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "PartnerUserPermissionGroupType" : { "type" : "object", "description" : "Updated partner permission group configuration", "properties" : { "assignablePermissionGroups" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "clientAssignablePermissionGroupsMap" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, "nullable" : true }, "clientFunctionalityList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FunctionalityEnum" }, "nullable" : true }, "clientPermissionMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PartnerPermissionEnum" }, "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "functionalityList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartnerFunctionalityEnum" }, "nullable" : true }, "mutable" : { "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "superAdmin" : { "type" : "boolean", "nullable" : true }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_ClientCustomizationsType" : { "type" : "object", "description" : "Client-specific customization settings for partner management.", "properties" : { "forceLowBandwidthOnAllCameras" : { "type" : "boolean", "description" : "Whether to force low bandwidth on all cameras", "example" : false, "nullable" : true }, "inactivityTimeout" : { "type" : "integer", "format" : "int32", "description" : "Inactivity timeout in minutes", "example" : 30, "nullable" : true } } }, "Partner_ClientDeviceCustomizationsType" : { "type" : "object", "description" : "Client device-specific customization settings for partner management.", "properties" : { "forceLowBandwidthOnAllCameras" : { "type" : "boolean", "description" : "Whether to force low bandwidth on all cameras", "example" : false, "nullable" : true }, "inactivityTimeout" : { "type" : "integer", "format" : "int32", "description" : "Inactivity timeout in minutes", "example" : 30, "nullable" : true } } }, "Partner_ConnectionCountType" : { "type" : "object", "description" : "Device connection count information for partner clients.", "properties" : { "connectedCount" : { "type" : "integer", "format" : "int32", "description" : "Number of connected devices", "example" : 45, "nullable" : true }, "operationalCount" : { "type" : "integer", "format" : "int32", "description" : "Number of operational devices", "example" : 42, "nullable" : true }, "totalCount" : { "type" : "integer", "format" : "int32", "description" : "Total number of devices", "example" : 50, "nullable" : true } } }, "Partner_CreatePartnerClientWSRequest" : { "type" : "object", "description" : "Request object for creating a new partner client account.", "properties" : { "allowDuplicateName" : { "type" : "boolean", "description" : "MSP initiative (D8): create even if this MSP already manages an org with the same name (case-insensitive). Default false.", "nullable" : true }, "clientContactEmail" : { "type" : "string", "description" : "Email address of the client contact person", "example" : "john.smith@acme.com", "nullable" : true }, "clientContactName" : { "type" : "string", "description" : "Name of the client contact person", "example" : "John Smith", "nullable" : true }, "clientOrgName" : { "type" : "string", "description" : "Name of the client organization", "example" : "Acme Corporation", "nullable" : true }, "suppressWelcomeEmail" : { "type" : "boolean", "description" : "Whether to suppress sending welcome email to the client", "example" : false, "nullable" : true } } }, "Partner_CreatePartnerClientWSResponse" : { "type" : "object", "description" : "Response object containing the result of creating a partner client account.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "responseStatus" : { "$ref" : "#/components/schemas/Partner_PartnerWebResponseStatusEnum" }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_CustomizeClientDeviceWSRequest" : { "type" : "object", "description" : "Request object for customizing client device settings and configurations.", "properties" : { "clientDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "configUpdate" : { "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" }, "customizations" : { "$ref" : "#/components/schemas/Partner_ClientDeviceCustomizationsType" } } }, "Partner_CustomizeClientDeviceWSResponse" : { "type" : "object", "description" : "Response object containing the applied client device customization settings.", "properties" : { "customizations" : { "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_CustomizeClientWSRequest" : { "type" : "object", "description" : "Request object for customizing client settings and configurations.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "customizations" : { "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" } } }, "Partner_CustomizeClientWSResponse" : { "type" : "object", "description" : "Response object containing the applied client customization settings.", "properties" : { "customizations" : { "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_DeleteClientWebRequest" : { "type" : "object", "description" : "Request object for deleting a partner client account.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_DeleteClientWebResponse" : { "type" : "object", "description" : "Response object for deleting a partner client account." }, "Partner_DeviceWithPartnerDetailsType" : { "type" : "object", "description" : "Device information with partner-specific details including control and reassignment status.", "properties" : { "device" : { "$ref" : "#/components/schemas/DeviceTypeV2" }, "partnerControlledHardware" : { "type" : "boolean", "description" : "Whether the hardware is controlled by the partner", "example" : true, "nullable" : true }, "reassignable" : { "type" : "boolean", "description" : "Whether the device can be reassigned to another organization", "example" : true, "nullable" : true } } }, "Partner_GetClientDevicesWSRequest" : { "type" : "object", "description" : "Request object for getting devices for a specific client organization.", "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetClientDevicesWSResponse" : { "type" : "object", "description" : "Response object containing devices for a specific client organization.", "properties" : { "devices" : { "type" : "array", "description" : "List of devices with partner-specific details", "items" : { "$ref" : "#/components/schemas/Partner_DeviceWithPartnerDetailsType" }, "nullable" : true } } }, "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSBaseResponse" : { "type" : "object", "description" : "Base response for getting client Rhombus organization users for partner activation token V2", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" }, { "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "failureReason" : { "type" : "string", "description" : "Reason for the failure", "example" : "Invalid activation token", "nullable" : true } } } ], "description" : "Failure response for getting client Rhombus organization users for partner activation token V2.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSRequest" : { "type" : "object", "description" : "Request object for getting client Rhombus organization users for partner activation token V2.", "properties" : { "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "orgs" : { "type" : "array", "description" : "List of Rhombus organizations the user has access to", "items" : { "$ref" : "#/components/schemas/OrgV2Type" }, "nullable" : true } } } ], "description" : "Success response for getting client Rhombus organization users for partner activation token V2.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_GetClientSummaryInfoWSRequest" : { "type" : "object", "description" : "Request object for getting client summary information.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetClientSummaryInfoWSResponse" : { "type" : "object", "description" : "Response object containing client summary information including account owner, device status, and settings.", "properties" : { "accountOwner" : { "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" }, "clientDeviceStatusMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Partner_ConnectionCountType" }, "description" : "Map of device types to their connection status counts", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "licenseV2Enabled" : { "type" : "boolean", "description" : "Whether license V2 is enabled for the client", "example" : true, "nullable" : true }, "locationCount" : { "type" : "integer", "format" : "int32", "description" : "Number of locations for the client", "example" : 3, "nullable" : true }, "manuallySendLicenseExpirationEmailEnabled" : { "type" : "boolean", "description" : "Whether manual license expiration email sending is enabled", "example" : false, "nullable" : true }, "recentPolicyAlertCount" : { "type" : "integer", "format" : "int32", "description" : "Number of recent policy alerts", "example" : 5, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_GetListOfAllClientDevicesRequest" : { "type" : "object", "description" : "Request object for getting list of all client devices." }, "Partner_GetListOfAllClientDevicesResponse" : { "type" : "object", "description" : "Response object containing list of all client devices.", "properties" : { "listOfAllClientDevices" : { "type" : "array", "description" : "List of all client devices", "items" : { "$ref" : "#/components/schemas/DeviceTypeV2" }, "nullable" : true } } }, "Partner_GetListOfControlledHardwareRequest" : { "type" : "object", "description" : "Request object for getting list of controlled hardware." }, "Partner_GetListOfControlledHardwareResponse" : { "type" : "object", "description" : "Response object containing list of controlled hardware.", "properties" : { "controlledHardwareList" : { "type" : "array", "description" : "List of controlled hardware", "items" : { "$ref" : "#/components/schemas/Partner_UnregisteredControlledHardwareType" }, "nullable" : true } } }, "Partner_GetPartnerAccessRequestSummaryV3WSBaseResponse" : { "type" : "object", "description" : "Base response for fetching pending partner access request summary (V3).", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Partner_GetPartnerAccessRequestSummaryV3WSFailureResponse" }, { "$ref" : "#/components/schemas/Partner_GetPartnerAccessRequestSummaryV3WSSuccessResponse" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "Partner_GetPartnerAccessRequestSummaryV3WSFailureResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "failureReason" : { "type" : "string", "description" : "Reason for the failure", "example" : "Session expired", "nullable" : true } } } ], "description" : "Failure response for fetching pending partner access request summary (V3).", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_GetPartnerAccessRequestSummaryV3WSRequest" : { "type" : "object", "description" : "Request object for fetching summary info for a pending partner access request (V3, session-authenticated).", "properties" : { "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetPartnerAccessRequestSummaryV3WSSuccessResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "partnerName" : { "type" : "string", "description" : "Display name of the partner requesting access", "nullable" : true } } } ], "description" : "Success response for fetching a pending partner access request summary (V3). The request is scoped to a single org, so this returns just the partner identity for display; the approving user is already in that org's tenant.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_GetPartnerClientMobileAccountAccessRequest" : { "type" : "object", "description" : "Request object for getting partner client mobile account access.", "properties" : { "authorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetPartnerClientMobileAccountAccessResponse" : { "type" : "object", "description" : "Response object containing partner client mobile account access session.", "properties" : { "clientAccountAccessSessionId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GetPartnerClientsStatusMapWSRequest" : { "type" : "object", "description" : "Request object for getting partner clients status map." }, "Partner_GetPartnerClientsStatusMapWSResponse" : { "type" : "object", "description" : "Response object containing partner clients status map with device connection counts.", "properties" : { "clientDeviceStatusMap" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Partner_ConnectionCountType" }, "description" : "Map of client UUIDs to device type connection counts", "nullable" : true }, "description" : "Map of client UUIDs to device type connection counts", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_GetPartnerClientsWSRequest" : { "type" : "object", "description" : "Request object for getting all partner clients.", "properties" : { "includeDeactivated" : { "type" : "boolean", "description" : "MSP initiative: also return soft-deleted (deactivated) client orgs still inside the restore window. Default false.", "nullable" : true } } }, "Partner_GetPartnerClientsWSResponse" : { "type" : "object", "description" : "Response object containing list of partner clients.", "properties" : { "clients" : { "type" : "array", "description" : "List of partner clients", "items" : { "$ref" : "#/components/schemas/Partner_PartnerClientWebType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_GetPartnerUsersInOrgWSRequest" : { "type" : "object", "description" : "Request object for getting partner users in organization." }, "Partner_GetPartnerUsersInOrgWSResponse" : { "type" : "object", "description" : "Response object containing partner users in organization with notification settings and permissions.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "notificationSettingsV2" : { "type" : "array", "description" : "List of partner notification settings V2", "items" : { "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" }, "nullable" : true }, "partnerPermissions" : { "type" : "array", "description" : "List of partner permissions", "items" : { "$ref" : "#/components/schemas/PartnerPermissionType" }, "nullable" : true }, "partnerUsers" : { "type" : "array", "description" : "List of partner users in the organization", "items" : { "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_GetShipmentsWSRequest" : { "type" : "object", "description" : "Request object for getting client shipments within a time range.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "endTimeSec" : { "type" : "integer", "format" : "int64", "description" : "End time for shipment search (seconds since epoch)", "example" : 1640995200, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", "description" : "Start time for shipment search (seconds since epoch)", "example" : 1640908800, "nullable" : true } } }, "Partner_GetShipmentsWSResponse" : { "type" : "object", "description" : "Response object containing client shipments within the specified time range.", "properties" : { "customerShipmentList" : { "type" : "array", "description" : "List of customer shipments", "items" : { "$ref" : "#/components/schemas/CustomerShipmentType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_GrantSupportAccessToClientWSRequest" : { "type" : "object", "description" : "Request object for granting support access to a client account.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_GrantSupportAccessToClientWSResponse" : { "type" : "object", "description" : "Response object for granting support access to a client account.", "properties" : { "errMessage" : { "type" : "string", "description" : "Error message if support access grant failed", "example" : "Client organization not found", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_PartnerClientWebType" : { "type" : "object", "description" : "Partner client information including organization details and device counts.", "properties" : { "authorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientAccessAllowed" : { "type" : "boolean", "description" : "Whether client access is allowed (duplicate getter)", "example" : true, "nullable" : true }, "clientAccountAccessUrl" : { "type" : "string", "description" : "URL for accessing the client account", "example" : "https://console.rhombussystems.com/client/access", "nullable" : true }, "clientOrgName" : { "type" : "string", "description" : "Name of the client organization", "example" : "Acme Corporation", "nullable" : true }, "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "clientSuperAdminAssignable" : { "type" : "boolean", "description" : "MSP initiative (D3): false when the MSP has restricted the client org's Super Admin role.", "nullable" : true }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the client was created (milliseconds since epoch)", "example" : 1640995200000, "nullable" : true }, "deactivated" : { "type" : "boolean", "description" : "MSP initiative: true when the client org is soft-deleted (only returned with includeDeactivated=true).", "nullable" : true }, "deactivatedAtMillis" : { "type" : "integer", "format" : "int64", "description" : "MSP initiative: when the client org was deactivated, if it is.", "nullable" : true }, "managedByMsp" : { "type" : "boolean", "description" : "MSP initiative: true when this client is a managed org owned by the calling MSP (permanent authority).", "nullable" : true }, "totalAudioGateways" : { "type" : "integer", "format" : "int32", "description" : "Total number of audio gateways", "example" : 4, "nullable" : true }, "totalBadgeReaders" : { "type" : "integer", "format" : "int32", "description" : "Total number of badge readers", "example" : 12, "nullable" : true }, "totalCameras" : { "type" : "integer", "format" : "int32", "description" : "Total number of cameras", "example" : 25, "nullable" : true }, "totalClimateSensors" : { "type" : "integer", "format" : "int32", "description" : "Total number of climate sensors", "example" : 10, "nullable" : true }, "totalDoorSensors" : { "type" : "integer", "format" : "int32", "description" : "Total number of door sensors", "example" : 8, "nullable" : true }, "totalLocations" : { "type" : "integer", "format" : "int32", "description" : "Total number of locations", "example" : 3, "nullable" : true }, "totalOccupancySensors" : { "type" : "integer", "format" : "int32", "description" : "Total number of occupancy sensors", "example" : 6, "nullable" : true }, "totalProximitySensors" : { "type" : "integer", "format" : "int32", "description" : "Total number of proximity sensors", "example" : 5, "nullable" : true } } }, "Partner_PartnerWebResponseStatusEnum" : { "type" : "string", "description" : "Status responses for partner web operations.", "enum" : [ "BASIC_AUTH_FAILED", "PASSWORD_MISMATCH", "USER_EXISTS", "CLIENT_EXISTS", "USER_NOT_FOUND", "BAD_INPUT", "SUCCESS", "PASSWORD_TOO_SHORT" ] }, "Partner_ReassignDeviceOrgWSRequest" : { "type" : "object", "description" : "Request object for reassigning devices from one organization to another.", "properties" : { "serialNumbers" : { "type" : "array", "description" : "Serial numbers of the devices that should be reassigned to target organization", "items" : { "type" : "string", "description" : "Serial numbers of the devices that should be reassigned to target organization", "nullable" : true }, "nullable" : true }, "sourceOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "targetOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } }, "required" : [ "sourceOrgUuid", "targetOrgUuid" ] }, "Partner_ReassignDeviceOrgWSResponse" : { "type" : "object", "description" : "Response object containing the status of device reassignment operations.", "properties" : { "statuses" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OperationStatus" }, "description" : "Map of device serial numbers to their reassignment operation status", "nullable" : true } } }, "Partner_RegisterDealWSRequest" : { "type" : "object", "description" : "Request object for registering a deal with partner details.", "properties" : { "details" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Map of deal details with key-value pairs", "nullable" : true }, "description" : "Map of deal details with key-value pairs", "nullable" : true } } }, "Partner_RegisterDealWSResponse" : { "type" : "object", "description" : "Response object containing the result of registering a deal.", "properties" : { "clients" : { "type" : "array", "description" : "List of partner clients associated with the registered deal", "items" : { "$ref" : "#/components/schemas/Partner_PartnerClientWebType" }, "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_RequestAccessToClientAccountRequest" : { "type" : "object", "description" : "Request object for requesting access to a client account (deprecated, use V2).", "properties" : { "clientEmail" : { "type" : "string", "description" : "Email address of the client to request access for", "example" : "client@acme.com", "nullable" : true } } }, "Partner_RequestAccessToClientAccountResponse" : { "type" : "object", "description" : "Response object for requesting access to a client account (deprecated, use V2).", "properties" : { "success" : { "type" : "boolean", "description" : "Whether the access request was successful", "example" : true, "nullable" : true } } }, "Partner_RequestAccessToClientAccountV2Request" : { "type" : "object", "description" : "Request object for requesting access to a client account V2.", "properties" : { "clientEmail" : { "type" : "string", "description" : "Email address of the client to request access for", "example" : "client@acme.com", "nullable" : true } } }, "Partner_RequestAccessToClientAccountV2Response" : { "type" : "object", "description" : "Response object for requesting access to a client account V2.", "properties" : { "success" : { "type" : "boolean", "description" : "Whether the access request was successful", "example" : true, "nullable" : true } } }, "Partner_RequestAccessToClientAccountV3Request" : { "type" : "object", "description" : "Request object for requesting access to a client account V3. V3 differs from V2 in that the request is scoped to a specific client org (the partner initiates it from that client's row), and the email links to an authenticated in-Console approval page (instead of an anonymous token-auth landing page) deep-linked to that org, enabling explicit role selection at approval time.", "properties" : { "clientEmail" : { "type" : "string", "description" : "Email address of the client to request access for", "example" : "client@acme.com", "nullable" : true }, "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_RequestAccessToClientAccountV3Response" : { "type" : "object", "description" : "Response object for requesting access to a client account V3.", "properties" : { "success" : { "type" : "boolean", "description" : "Whether the access request was successful", "example" : true, "nullable" : true } } }, "Partner_SubmitPartnerAccessRequestDecisionV3WSBaseResponse" : { "type" : "object", "description" : "Base response for submitting partner access request decision (V3).", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Partner_SubmitPartnerAccessRequestDecisionV3WSFailureResponse" }, { "$ref" : "#/components/schemas/Partner_SubmitPartnerAccessRequestDecisionV3WSSuccessResponse" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "Partner_SubmitPartnerAccessRequestDecisionV3WSFailureResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "failureReason" : { "type" : "string", "description" : "Reason for the failure", "example" : "Invalid role for selected org", "nullable" : true } } } ], "description" : "Failure response for submitting partner access request decision (V3).", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_SubmitPartnerAccessRequestDecisionV3WSRequest" : { "type" : "object", "description" : "Request object for the customer's decision on a pending partner access request (V3, session-authenticated). Caller's session identifies the customer; clientRoleUuid is the explicit role the customer chose for the partner.", "properties" : { "accessGrantedByClient" : { "type" : "boolean", "description" : "Whether access was granted by the client", "example" : true, "nullable" : true }, "clientRoleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_SubmitPartnerAccessRequestDecisionV3WSSuccessResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for submitting partner access request decision (V3).", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSBaseResponse" : { "type" : "object", "description" : "Base response for submitting support access decision for partner activation token V2", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" }, { "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" } ], "properties" : { "type" : { "type" : "string" } }, "required" : [ "type" ] }, "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { "failureReason" : { "type" : "string", "description" : "Reason for the failure", "example" : "Invalid activation token", "nullable" : true } } } ], "description" : "Failure response for submitting support access decision for partner activation token V2.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSRequest" : { "type" : "object", "description" : "Request object for submitting support access decision for partner activation token V2.", "properties" : { "accessGrantedByClient" : { "type" : "boolean", "description" : "Whether access was granted by the client", "example" : true, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "token" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" : { "type" : "object", "allOf" : [ ], "description" : "Success response for submitting support access decision for partner activation token V2.", "nullable" : true, "properties" : { "type" : { "type" : "string" } } }, "Partner_UnregisteredControlledHardwareType" : { "type" : "object", "description" : "Information about unregistered controlled hardware available for partner registration.", "properties" : { "deviceModel" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, "deviceType" : { "$ref" : "#/components/schemas/DeviceTypeEnum" }, "macAddress" : { "type" : "string", "description" : "MAC address of the hardware device", "example" : "00:11:22:33:44:55", "nullable" : true }, "serialNumber" : { "type" : "string", "description" : "Serial number of the hardware device", "example" : "RH123456789", "nullable" : true } } }, "Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" : { "type" : "object", "description" : "Request object for updating manual license expiration email settings for an organization.", "properties" : { "manuallySendLicenseExpirationEmail" : { "type" : "boolean", "description" : "Whether to manually send license expiration emails", "example" : true, "nullable" : true }, "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, "Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" : { "type" : "object", "description" : "Response object for updating manual license expiration email settings.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_AssignLicensesToClientWSRequest" : { "type" : "object", "description" : "Move unassigned pool licenses to a managed client.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true }, "quantity" : { "type" : "integer", "format" : "int32", "nullable" : true }, "requestId" : { "type" : "string", "description" : "Idempotency key; retries with the same id are safe.", "nullable" : true } } }, "Partner_msp_AssignLicensesToClientWSResponse" : { "type" : "object", "description" : "Per-license outcome of an assignment.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "failed" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Partner_msp_LicenseOperationFailureWSType" }, "nullable" : true }, "moved" : { "type" : "array", "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_BlockingDeviceWSType" : { "type" : "object", "description" : "A registered device that blocks deactivation.", "properties" : { "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, "serial" : { "type" : "string", "nullable" : true } } }, "Partner_msp_BlockingLicenseWSType" : { "type" : "object", "description" : "A pooled license still assigned to a device that blocks deactivation.", "properties" : { "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "productCode" : { "type" : "string", "nullable" : true } } }, "Partner_msp_ClaimLicensesToPoolWSRequest" : { "type" : "object", "description" : "Claim a key into the MSP's own pool.", "properties" : { "claimCode" : { "type" : "string", "nullable" : true } } }, "Partner_msp_ClaimLicensesToPoolWSResponse" : { "type" : "object", "description" : "Result of claiming a key into the pool.", "properties" : { "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_DeactivateClientWSRequest" : { "type" : "object", "description" : "Deactivate (soft delete) a managed client org.", "properties" : { "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "confirmName" : { "type" : "string", "description" : "Typed confirmation; must match the client org name.", "nullable" : true } } }, "Partner_msp_DeactivateClientWSResponse" : { "type" : "object", "description" : "Outcome of a client deactivation.", "properties" : { "blockedByDevices" : { "type" : "array", "description" : "Devices still registered in the client org.", "items" : { "$ref" : "#/components/schemas/Partner_msp_BlockingDeviceWSType" }, "nullable" : true }, "blockedByLicenses" : { "type" : "array", "description" : "Pooled licenses still assigned to devices in the client org.", "items" : { "$ref" : "#/components/schemas/Partner_msp_BlockingLicenseWSType" }, "nullable" : true }, "deactivated" : { "type" : "boolean", "description" : "True when the org was soft-deleted by this call (or already was).", "nullable" : true }, "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "reclaimedLicenses" : { "type" : "integer", "format" : "int32", "description" : "Pooled licenses moved back to the MSP by this call.", "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_DoorBindingWSType" : { "type" : "object", "description" : "An access-control binding that prevents a hardware move.", "properties" : { "name" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "description" : "DOOR", "nullable" : true } } }, "Partner_msp_GetHardwareInventoryWSRequest" : { "type" : "object", "description" : "Request for the MSP's controlled hardware (no fields)." }, "Partner_msp_GetHardwareInventoryWSResponse" : { "type" : "object", "description" : "The MSP's controlled hardware across all clients.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "units" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Partner_msp_HardwareInventoryUnitWSType" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_GetLicensePoolWSRequest" : { "type" : "object", "description" : "Request for the MSP's license pool (no fields)." }, "Partner_msp_GetLicensePoolWSResponse" : { "type" : "object", "description" : "The MSP's license pool.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, "errorCode" : { "type" : "string", "description" : "Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.", "nullable" : true }, "errorMsg" : { "type" : "string", "nullable" : true }, "products" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Partner_msp_LicensePoolProductWSType" }, "nullable" : true }, "unclaimedKeys" : { "type" : "array", "description" : "CREATED (not yet claimed) keys for the partner, as getClaimKeysForPartnerOrg returns them.", "items" : { "$ref" : "#/components/schemas/PartnerOrgClaimKey" }, "nullable" : true }, "warningMsg" : { "type" : "string", "nullable" : true } } }, "Partner_msp_GetPartnerOrgProfileWSRequest" : { "type" : "object", "description" : "Request for the calling partner org's MSP profile (no fields)." }, "Partner_msp_GetPartnerOrgProfileWSResponse" : { "type" : "object", "description" : "The calling partner org's MSP profile.", "properties" : { "error" : {