erp_uti

Monitor

207 views 22/10/2018 02/06/2020 integrador 0

2.0info: 1.5.0 monitor description: Serviço do monitor do SAM x-senior-domain: sam x-senior-domain-path: sam x-senior-service-path: monitor contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/samsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /monitor/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError /monitor/queries/getPhysicalLocationChildren: post: description: Busca os locais filhos do local físico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – physicalLocationId – statusFilter – rangeFilter properties: physicalLocationId: type: integer format: int64 description: Id do local físico statusFilter: type: string allOf: – #/definitions/statusFilter description: Filtro de status rangeFilter: type: string allOf: – #/definitions/physicalLocationRangeFilter description: Filtro de abrangência responses: 200: description: Ok schema: type: object required: – physicalLocationChildRecord properties: physicalLocationChildRecord: type: array items: type: object allOf: – #/definitions/physicalLocationChildRecord minimum: 1 description: Locais filhos default: description: Error response schema: #/definitions/genericError /monitor/queries/getAnalyticsTotalOfPeoplePresent: post: description: Retorna o total de pessoas presentes tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – peoplePresentCount properties: peoplePresentCount: type: integer format: int64 description: Total de pessoas presentes default: description: Error response schema: #/definitions/genericError get: description: Retorna o total de pessoas presentes tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – peoplePresentCount properties: peoplePresentCount: type: integer format: int64 description: Total de pessoas presentes default: description: Error response schema: #/definitions/genericError /monitor/queries/getAnalyticsAlarmedInputCount: post: description: Retorna o total de entradas alarmadas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – totalAlarmedInput properties: totalAlarmedInput: type: integer format: int64 description: Total de entradas alarmadas default: description: Error response schema: #/definitions/genericError get: description: Retorna o total de entradas alarmadas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – totalAlarmedInput properties: totalAlarmedInput: type: integer format: int64 description: Total de entradas alarmadas default: description: Error response schema: #/definitions/genericError /monitor/queries/getAnalyticsDeviceComunicationStatus: post: description: Retorna o total de gerenciadores online, offline e o total de módulos online e offline tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – total properties: total: type: object allOf: – #/definitions/managerModuleCountRecord description: Total de gerenciadores e módulos online e offline default: description: Error response schema: #/definitions/genericError get: description: Retorna o total de gerenciadores online, offline e o total de módulos online e offline tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – total properties: total: type: object allOf: – #/definitions/managerModuleCountRecord description: Total de gerenciadores e módulos online e offline default: description: Error response schema: #/definitions/genericError /monitor/queries/getIrregularPeoplePresence: post: description: Busca de presenças irregulares de pessoas em determinado local físico por determinada regra de validação de acesso tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – physicalLocationId – validationRule properties: physicalLocationId: type: integer format: int64 description: Id do local físico validationRule: type: string allOf: – #/definitions/validationRuleIrregularPresence description: Regra da validação de acesso a ser verificado responses: 200: description: Ok schema: type: object required: – irregularPeoplePresence properties: irregularPeoplePresence: type: array items: type: object allOf: – #/definitions/personPresenceRecord minimum: 1 description: Pessoas irregulares no local default: description: Error response schema: #/definitions/genericError /monitor/queries/getCamerasFromDevice: post: description: Retorna as câmeras associadas ao dispositivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: deviceId: type: integer format: int64 description: Identificador do dispositivo responses: 200: description: Ok schema: type: object required: – cameras properties: cameras: type: array items: type: object allOf: – #/definitions/cameraRecord minimum: 1 description: Lista de câmeras default: description: Error response schema: #/definitions/genericError get: description: Retorna as câmeras associadas ao dispositivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: deviceId description: Identificador do dispositivo in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – cameras properties: cameras: type: array items: type: object allOf: – #/definitions/cameraRecord minimum: 1 description: Lista de câmeras default: description: Error response schema: #/definitions/genericError /monitor/queries/groupLookup: post: description: Retorna uma lista de grupos para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro de pesquisa displayfields: type: string description: Display fields size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Índice da página (inicia em zero) minimum: 0 default: 0 orderBy: type: string description: Parâmetro de ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/simpleGroupRecord minimum: 1 description: Lista de papéis grupos default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de grupos para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro de pesquisa in: query type: string – name: displayfields description: Display fields in: query type: string – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Índice da página (inicia em zero) in: query type: integer format: int64 – name: orderBy description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/simpleGroupRecord minimum: 1 description: Lista de papéis grupos default: description: Error response schema: #/definitions/genericError /monitor/queries/listRealTimeClockIn: post: description: Retorna todas as marcações realizadas em dispositivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clockInCount properties: roleIds: type: array items: type: integer format: int64 description: IDs dos papéis personIds: type: array items: type: integer format: int64 description: IDs das pessoas deviceIds: type: array items: type: integer format: int64 description: IDs dos dispositivos physicalLocationIds: type: array items: type: integer format: int64 description: IDs dos locais físicos clockInCount: type: integer format: int64 description: Quantidade de registros responses: 200: description: Ok schema: type: object required: – access properties: access: type: array items: type: object allOf: – #/definitions/clockInRecord minimum: 1 description: Lista dos registros de acesso de ponto default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as marcações realizadas em dispositivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: roleIds description: IDs dos papéis in: query type: array items: type: integer format: int64 – name: personIds description: IDs das pessoas in: query type: array items: type: integer format: int64 – name: deviceIds description: IDs dos dispositivos in: query type: array items: type: integer format: int64 – name: physicalLocationIds description: IDs dos locais físicos in: query type: array items: type: integer format: int64 – name: clockInCount description: Quantidade de registros in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – access properties: access: type: array items: type: object allOf: – #/definitions/clockInRecord minimum: 1 description: Lista dos registros de acesso de ponto default: description: Error response schema: #/definitions/genericError /monitor/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportTimeZone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportLocalTimeZone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportPhysicalLocation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportDevice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportInputDevice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportManagerDevice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportModuleDevice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportAccess: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportAccessRejected: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportBlueprint: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportCamera: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportClockIn: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportDvrServer: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/exportCctvProxy: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /monitor/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /monitor/actions/importTimeZone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importLocalTimeZone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importPhysicalLocation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importDevice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importInputDevice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importManagerDevice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importModuleDevice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importAccess: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importAccessRejected: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importBlueprint: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importCamera: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importClockIn: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importDvrServer: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/actions/importCctvProxy: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /monitor/entities/timeZone: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/timeZone default: description: Error response schema: #/definitions/genericError /monitor/entities/localTimeZone: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/localTimeZone default: description: Error response schema: #/definitions/genericError /monitor/entities/physicalLocation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError /monitor/entities/device: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/device default: description: Error response schema: #/definitions/genericError /monitor/entities/inputDevice: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inputDevice default: description: Error response schema: #/definitions/genericError /monitor/entities/managerDevice: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/managerDevice default: description: Error response schema: #/definitions/genericError /monitor/entities/moduleDevice: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/moduleDevice default: description: Error response schema: #/definitions/genericError /monitor/entities/access: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/access default: description: Error response schema: #/definitions/genericError /monitor/entities/accessRejected: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accessRejected default: description: Error response schema: #/definitions/genericError /monitor/entities/person: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/person default: description: Error response schema: #/definitions/genericError /monitor/entities/blueprint: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/blueprint default: description: Error response schema: #/definitions/genericError /monitor/entities/camera: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/camera responses: 200: description: The created resource schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/camera responses: 200: description: The created resource schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/camera default: description: Error response schema: #/definitions/genericError /monitor/entities/camera/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/camera responses: 200: description: Ok schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/camera responses: 200: description: Ok schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /monitor/entities/camera/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/camera responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /monitor/entities/cameraDevice: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError /monitor/entities/camera/{parentId}/devices: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/cameraDevice responses: 200: description: The created resources schema: type: array items: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/cameraDevice responses: 200: description: The created resources schema: type: array items: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError /monitor/entities/camera/{parentId}/devices/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cameraDevice responses: 200: description: Ok schema: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cameraDevice responses: 200: description: Ok schema: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cameraDevice default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /monitor/entities/clockIn: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/clockIn default: description: Error response schema: #/definitions/genericError /monitor/entities/dvrServer: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dvrServer default: description: Error response schema: #/definitions/genericError /monitor/entities/cctvProxy: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cctvProxy default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN cameraStatus: description: Status da Câmera type: string enum: – ACTIVE – INACTIVE dvrServerType: description: Tipo do Servidor DVR type: string enum: – DIGIFORT – CAMERITE – MILESTONE – AXXON validationRuleIrregularPresence: description: Regras de validação de acesso para presenças irregulares type: string enum: – ROLE_TIME_SLOT healthStatus: description: Status da instância type: string enum: – HEALTH – UNHEALTHY deviceType: description: Tipo do Dispositivo type: string enum: – MANAGER – READER – MODULE – INPUT – OUTPUT deviceSituation: description: Situação do Dispositivo type: string enum: – INACTIVE – ACTIVE deviceCommunicationStatus: description: Status de Comunicação do Dispositivo type: string enum: – OFFLINE – ONLINE inputState: description: Estado Padrão de Entrada type: string enum: – INACTIVE – ACTIVE statusFilter: description: Filtro de Status type: string enum: – ALL – ONLY_ACTIVE physicalLocationRangeFilter: description: Filtro de Abrangência para Local Físico type: string enum: – ALL – VALID_RANGE_IN_HIERARCHY physicalLocationStatus: description: Status do Local Físico type: string enum: – DISABLED – ENABLED daylightSavingType: description: Status do Local Físico type: string enum: – NONE_OFFSET – MINUS_ONE_HOUR – PLUS_ONE_HOUR userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde physicalLocationChildRecord: description: Local filho do local físico type: object required: – id – name – parentId – status – hasValidRange – hasBlueprint properties: id: type: integer format: int64 description: Identificador name: type: string maxLength: 50 description: Nome parentId: type: integer format: int64 description: Identificador do local físico pai status: type: string allOf: – #/definitions/physicalLocationStatus description: Status hasValidRange: type: boolean description: Tem abrangência hasBlueprint: type: boolean description: Tem planta basicDocumentTypeRecord: description: Dados básicos do tipo de documento para sua exibição junto com um documento type: object required: – id – label – mask properties: id: type: integer format: int64 description: Identificador label: type: string maxLength: 20 description: Label para exibição do tipo do documento mask: type: string maxLength: 30 description: Máscara para aplicação no documento basicDocumentRecord: description: Dados básicos do documento para visualização type: object required: – id – document – documentType properties: id: type: integer format: int64 description: Identificador document: type: string maxLength: 30 description: Valor do documento documentType: type: object allOf: – #/definitions/basicDocumentTypeRecord description: Tipo do documento basicPersonRecord: description: Dados básicos para identificação e visualização de uma pessoa type: object required: – id – name – document properties: id: type: integer format: int64 description: Identificador name: type: string maxLength: 50 description: Nome document: type: object allOf: – #/definitions/basicDocumentRecord description: Documento da pessoa (primeiro documento obrigatório encontrado) basicPhysicalLocationRecord: description: Informações básicas para visualização de um local físico type: object required: – id – name properties: id: type: integer format: int64 description: Identificador name: type: string maxLength: 50 description: Nome personPresenceRecord: description: Dados básicos para identificação de uma pessoa type: object required: – accessDate – person – photoUrl – physicalLocation properties: accessDate: type: string format: date-time description: Data do acesso person: type: object allOf: – #/definitions/basicPersonRecord description: Pessoa que está presente photoUrl: type: string description: URL da foto da pessoa physicalLocation: type: object allOf: – #/definitions/basicPhysicalLocationRecord description: Local físico managerModuleCountRecord: description: Total de gerenciadores e módulos online e offline type: object required: – managersOnlineCount – managersOfflineCount – modulesOnlineCount – modulesOfflineCount properties: managersOnlineCount: type: integer format: int64 description: Total de Gerenciadores Online managersOfflineCount: type: integer format: int64 description: Total de Gerenciadores Offline modulesOnlineCount: type: integer format: int64 description: Total de Módulos Online modulesOfflineCount: type: integer format: int64 description: Total de Módulos Offline cameraRecord: description: Câmera type: object required: – name – isPTZ – physicalLocation – status properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome isPTZ: type: boolean description: Câmera PTZ dvrServer: type: object allOf: – #/definitions/dvrServerRecord description: Servidor DVR cameraServerId: type: string maxLength: 100 description: Servidor da Câmera streamLink: type: string maxLength: 2000 description: Link do Stream da Câmera physicalLocation: type: object allOf: – #/definitions/basicPhysicalLocationRecord description: Local Físico status: type: string allOf: – #/definitions/cameraStatus description: Status da Câmera cctvProxy: type: object allOf: – #/definitions/cctvProxyRecord description: Proxy CCTV urlStreaming: type: string maxLength: 2000 description: Url de streaming dvrServerRecord: description: Servidor DVR type: object required: – name – dvrServerType – user – password properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do Servidor dvrServerType: type: string allOf: – #/definitions/dvrServerType description: Tipo do Servidor DVR user: type: string maxLength: 50 description: Usuário de Acesso password: type: string maxLength: 50 description: Senha de Acesso host: type: string maxLength: 50 description: Identificador de Rede port: type: integer format: int64 description: Porta de Comunicação minimum: 1 maximum: 65535 networkDomain: type: string maxLength: 50 description: Domínio de Rede serverId: type: string maxLength: 100 description: Identificador do Servidor urlPrefix: type: string maxLength: 100 description: Prefixo da URL cctvProxyRecord: description: Proxy CFTV type: object required: – name – host – port properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome do Proxy CFTV host: type: string maxLength: 100 description: Host port: type: integer format: int64 description: Porta de Comunicação minimum: 1 maximum: 65535 clockInRecord: description: ClockIn type: object required: – person – device – clockInDate – physicalLocation – pis – nsr properties: person: type: object allOf: – #/definitions/basicPersonRecord description: Pessoa device: type: object allOf: – #/definitions/BasicDeviceRecord description: Dispositivo clockInDate: type: string format: date-time description: Data do registro physicalLocation: type: object allOf: – #/definitions/basicPhysicalLocationRecord description: Local físico pis: type: string maxLength: 12 description: PIS nsr: type: integer format: int64 description: NSR simpleGroupRecord: description: Grupo type: object required: – id – name – parentId – fullHierarchicalPath properties: id: type: integer format: int64 description: Identificador name: type: string maxLength: 50 description: Nome parentId: type: integer format: int64 description: Identificador do grupo pai fullHierarchicalPath: type: string description: Caminho hierárquico completo BasicDeviceRecord: description: Dispositivo type: object required: – id – name – deviceType properties: id: type: integer format: int64 description: ID name: type: string description: Nome deviceType: type: string allOf: – #/definitions/deviceType description: Tipo dispositivo timeZone: description: Fuso horário type: object properties: id: type: integer format: int64 description: ID offsetInMinutes: type: integer format: int64 description: Offset do fuso localTimeZone: description: Fuso horário de local type: object required: – timeZone – useDaylightSaving – daylightSavingType – daylightSavingStart – daylightSavingEnd properties: id: type: integer format: int64 description: ID timeZone: type: object allOf: – #/definitions/timeZone description: Fuso horário useDaylightSaving: type: boolean description: Utiliza horário de verão daylightSavingType: type: string allOf: – #/definitions/daylightSavingType description: Tipo de alteração do horário de verão daylightSavingStart: type: string format: date-time description: Início do horário de verão daylightSavingEnd: type: string format: date-time description: Fim do horário de verão physicalLocation: description: Local Físico type: object required: – name – parent – status – externalPhysicalLocation – checkSlotTimeRole – localTimeZone properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome parent: type: integer format: int64 description: Local Físico Pai status: type: string allOf: – #/definitions/physicalLocationStatus description: Status do Local Físico blueprint: type: object allOf: – #/definitions/blueprint description: Planta Baixa externalPhysicalLocation: type: boolean description: Local Físico Externo checkSlotTimeRole: type: boolean description: Verifica faixa horária do papel/escala localTimeZone: type: object allOf: – #/definitions/localTimeZone description: Fuso horário do local device: description: Dispositivo type: object required: – description – deviceType – situation – communicationStatus – physicalLocation properties: id: type: integer format: int64 description: ID description: type: string maxLength: 50 description: Descrição do Dispositivo deviceType: type: string allOf: – #/definitions/deviceType description: Tipo do Dispositivo situation: type: string allOf: – #/definitions/deviceSituation description: Situação do Dispositivo communicationStatus: type: string allOf: – #/definitions/deviceCommunicationStatus description: Status da Comunicação physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local Físico do Dispositivo inputDevice: description: Entrada type: object required: – defaultState properties: id: type: integer format: int64 description: ID defaultState: type: string allOf: – #/definitions/inputState description: Estado Padrão da Entrada inputState: type: string allOf: – #/definitions/inputState description: Estado Atual da Entrada managerDevice: description: Gerenciador type: object properties: id: type: integer format: int64 description: ID moduleDevice: description: Módulo type: object properties: id: type: integer format: int64 description: ID access: description: Acesso type: object properties: id: type: integer format: int64 description: ID accessRejected: description: Acesso Rejeitado type: object properties: id: type: integer format: int64 description: ID person: description: Pessoa type: object required: – name – lastAccessDate properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome currentPhysicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local Atual da Pessoa currentPhysicalLocationId: type: integer format: int64 description: Identificador do local atual da pessoa lastAccessDate: type: string format: date-time description: Último acesso da pessoa blueprint: description: Planta Baixa type: object properties: id: type: integer format: int64 description: ID physicalLocation: type: array items: type: object allOf: – #/definitions/physicalLocation description: Local físico camera: description: Câmera type: object required: – name – isPTZ – physicalLocation – status properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome isPTZ: type: boolean description: Câmera PTZ dvrServer: type: object allOf: – #/definitions/dvrServer description: Servidor DVR cameraServerId: type: string maxLength: 100 description: Servidor da Câmera streamLink: type: string maxLength: 2000 description: Link do Stream da Câmera physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local Físico status: type: string allOf: – #/definitions/cameraStatus description: Status da Câmera cctvProxy: type: object allOf: – #/definitions/cctvProxy description: Proxy CCTV devices: type: array items: type: object allOf: – #/definitions/cameraDevice description: Relação Câmera e Dispositivos urlStreaming: type: string maxLength: 2000 description: Url de streaming cameraDevice: description: Relação Câmera Dispositivo type: object required: – device properties: id: type: integer format: int64 description: ID camera: type: object allOf: – #/definitions/camera description: Câmera device: type: object allOf: – #/definitions/device description: Dispositivo clockIn: description: Marcação de ponto type: object required: – personId – pis – nsr – readerId properties: id: type: integer format: int64 description: ID accessDate: type: string format: date-time description: Data do acesso timezoneOffset: type: integer format: int64 description: Deslocamento do fuso horário personId: type: integer format: int64 description: ID da pessoa pis: type: string description: PIS nsr: type: integer format: int64 description: NSR readerId: type: integer format: int64 description: Leitora dvrServer: description: Servidor DVR type: object required: – name – dvrServerType – user – password properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do Servidor dvrServerType: type: string allOf: – #/definitions/dvrServerType description: Tipo do Servidor DVR user: type: string maxLength: 50 description: Usuário de Acesso password: type: string maxLength: 50 description: Senha de Acesso host: type: string maxLength: 50 description: Identificador de Rede port: type: integer format: int64 description: Porta de Comunicação minimum: 1 maximum: 65535 networkDomain: type: string maxLength: 50 description: Domínio de Rede serverId: type: string maxLength: 100 description: Identificador do Servidor urlPrefix: type: string maxLength: 100 description: Prefixo da URL cctvProxy: description: Proxy CFTV type: object required: – name – host – port properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome do Proxy CFTV host: type: string maxLength: 100 description: Host port: type: integer format: int64 description: Porta de Comunicação minimum: 1 maximum: 65535 notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment