Entities

89 operations.

Data models for Entities

Operations

• DELETE /projects/{projectId}/entities/{entityId} — Delete entity instance
• GET /projects/{projectId}/entities/{entityId} — Get entity instance
• PATCH /projects/{projectId}/entities/{entityId} — Update entity instance
• GET /projects/{projectId}/entities/{entityId}/alertRules — Get alert rules
• POST /projects/{projectId}/entities/{entityId}/alertRules — Create an alert rule
• DELETE /projects/{projectId}/entities/{entityId}/alertRules/{alertRuleId} — Delete an alert rule
• GET /projects/{projectId}/entities/{entityId}/alertRules/{alertRuleId} — Get an alert rule
• PATCH /projects/{projectId}/entities/{entityId}/alertRules/{alertRuleId} — Update an alert rule
• GET /projects/{projectId}/entities/{entityId}/alerts — Get alerts
• GET /projects/{projectId}/entities/{entityId}/alerts/{alertId} — Get alert
• PATCH /projects/{projectId}/entities/{entityId}/alerts/{alertId}/recover — Recover an alert
• GET /projects/{projectId}/entities/{entityId}/alertSchedules — Get alert schedules
• POST /projects/{projectId}/entities/{entityId}/alertSchedules — Create an alert schedule
• DELETE /projects/{projectId}/entities/{entityId}/alertSchedules/{alertScheduleId} — Delete an alert schedule
• GET /projects/{projectId}/entities/{entityId}/alertSchedules/{alertScheduleId} — Get an alert schedule
• PATCH /projects/{projectId}/entities/{entityId}/alertSchedules/{alertScheduleId} — Update an alert schedule
• DELETE /projects/{projectId}/entities/{entityId}/appProxy/{srcPath} — Proxy DELETE request to app server
• GET /projects/{projectId}/entities/{entityId}/appProxy/{srcPath} — Proxy GET request to app server
• PATCH /projects/{projectId}/entities/{entityId}/appProxy/{srcPath} — Proxy PATCH request to app server
• POST /projects/{projectId}/entities/{entityId}/appProxy/{srcPath} — Proxy POST request to app server
• PUT /projects/{projectId}/entities/{entityId}/appProxy/{srcPath} — Proxy PUT request to app server
• GET /projects/{projectId}/entities/{entityId}/assistants — Get assistants
• POST /projects/{projectId}/entities/{entityId}/assistants — Create an assistant
• DELETE /projects/{projectId}/entities/{entityId}/assistants/{assistantId} — Delete an assistant
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId} — Get an assistant
• PATCH /projects/{projectId}/entities/{entityId}/assistants/{assistantId} — Update an assistant
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/directRooms — Get Direct rooms
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/eventSubscriptions — Get event subscriptions
• POST /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/eventSubscriptions — Create event subscription
• DELETE /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/eventSubscriptions/{eventSubscriptionId} — Delete an event subscription
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/eventSubscriptions/{eventSubscriptionId} — Get an event subscription
• PATCH /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/eventSubscriptions/{eventSubscriptionId} — Update an event subscription
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/msTeamsTeams — Get MSTeams teams
• GET /projects/{projectId}/entities/{entityId}/assistants/{assistantId}/slackChannels — Get Slack channels
• GET /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId} — Get custom log definition
• GET /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/data — Get custom log data
• POST /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/data — Post custom log records
• DELETE /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/data/{entryId} — Delete log record entry
• GET /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/data/{entryId} — Get log record entry
• PATCH /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/data/{entryId} — Update log record entry
• POST /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/export — Export custom log data
• GET /projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/valueList/{fieldName} — Get custom log distinct values
• PUT /projects/{projectId}/entities/{entityId}/event — Send event to an entity
• GET /projects/{projectId}/entities/{entityId}/files — Get entity files
• DELETE /projects/{projectId}/entities/{entityId}/files/{fileId} — Delete an entity file
• GET /projects/{projectId}/entities/{entityId}/files/{fileId} — Get entity file metadata
• PATCH /projects/{projectId}/entities/{entityId}/files/{fileId} — Update entity file metadata
• DELETE /projects/{projectId}/entities/{entityId}/location — Delete location
• GET /projects/{projectId}/entities/{entityId}/location — Get location metadata
• PATCH /projects/{projectId}/entities/{entityId}/location — Update location
• DELETE /projects/{projectId}/entities/{entityId}/location/data — Delete location data
• GET /projects/{projectId}/entities/{entityId}/location/data — Get location data
• POST /projects/{projectId}/entities/{entityId}/location/data — Post location data
• DELETE /projects/{projectId}/entities/{entityId}/location/objectCounters/{counterId}/data — Delete object counter history
• GET /projects/{projectId}/entities/{entityId}/location/objectCounters/{counterId}/data — Get object counter history
• POST /projects/{projectId}/entities/{entityId}/manageMedia — Manage entity media
• DELETE /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId} — Delete metric
• GET /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId} — Get metrics definition
• PATCH /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId} — Update metric
• DELETE /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId}/data — Delete metrics data
• GET /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId}/data — Get metrics data
• POST /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId}/data — Post metrics data
• POST /projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId}/export — Export metrics data
• GET /projects/{projectId}/entities/{entityId}/scheduledReports — Get entity scheduled reports
• POST /projects/{projectId}/entities/{entityId}/scheduledReports — Create entity scheduled report
• DELETE /projects/{projectId}/entities/{entityId}/scheduledReports/{scheduledReportId} — Delete an entity scheduled report
• GET /projects/{projectId}/entities/{entityId}/scheduledReports/{scheduledReportId} — Get an entity scheduled report
• PATCH /projects/{projectId}/entities/{entityId}/scheduledReports/{scheduledReportId} — Update an entity scheduled report
• POST /projects/{projectId}/entities/{entityId}/scheduledReports/{scheduledReportId}/run — Run entity scheduled report manually
• POST /projects/{projectId}/entities/{entityId}/uploadFile — Upload a file
• GET /projects/{projectId}/entities/{entityId}/videoFeeds — Get video feeds
• POST /projects/{projectId}/entities/{entityId}/videoFeeds — Create a video feed
• DELETE /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId} — Delete a video feed
• GET /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId} — Get a video feed
• PATCH /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId} — Update a video feed
• GET /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}/files/{fileId} — Get a video feed file
• GET /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}/live — Get a live stream data of a video feed
• GET /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}/signaling — Open a WebRTC signaling session for a video feed
• GET /projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}/vod — Get the VOD stream of a video feed
• GET /projects/{projectId}/entities/{entityId}/workflows — Get entity workflows
• POST /projects/{projectId}/entities/{entityId}/workflows — Create an entity workflow
• DELETE /projects/{projectId}/entities/{entityId}/workflows/{workflowId} — Delete an entity workflow
• GET /projects/{projectId}/entities/{entityId}/workflows/{workflowId} — Get an entity workflow
• PATCH /projects/{projectId}/entities/{entityId}/workflows/{workflowId} — Update an entity workflow
• GET /projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs — Get entity workflow runs
• POST /projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs — Create run
• DELETE /projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs/{runId} — Delete run
• GET /projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs/{runId} — Get an entity workflow run
• PATCH /projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs/{runId} — Update run