Gestão Acesso e Segurança

metrics

17 views 20/07/2020 17/03/2021 integrador 0

2.0info: 3.13.0 metrics description: Serviço de métricas x-senior-domain: sam x-senior-domain-path: sam x-senior-service-path: metrics 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: /metrics/queries/healthcheck: post: description: Verifica a 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: Verifica a 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 /metrics/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 /metrics/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 /metrics/actions/getMetrics: post: description: Consulta métricas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/metricsInput responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metricTenant minimum: 1 description: default: description: Error response schema: #/definitions/genericError /metrics/actions/exportMetrics: post: description: Exporta métricas para arquivo csv tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/metricsInput responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: URL para download do arquivo CSV default: description: Error response schema: #/definitions/genericError /metrics/actions/exportAllMetricsToZip: post: description: Exporta todas métricas para determinados arquivos csv e compacta tudo num zip tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/searchMultipleMetricsInput responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: URL para download do arquivo ZIP default: description: Error response schema: #/definitions/genericError /metrics/actions/getValidations: post: description: Consulta validações ativas em determinado tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string description: Tenant size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 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/configuredValidations minimum: 1 description: Validações configuradas default: description: Error response schema: #/definitions/genericError /metrics/actions/exportValidations: post: description: Exporta validações ativas em determinado tenant para arquivo csv tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string description: Tenants responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: URL para download do arquivo CSV default: description: Error response schema: #/definitions/genericError /metrics/actions/collectAccessValidationMetrics: post: description: Executa a coleta de métricas da validação de acesso tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /metrics/actions/getDeviceManufacturer: post: description: Consulta de fabricantes do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – metric properties: metric: type: object allOf: – #/definitions/metricStacked description: default: description: Error response schema: #/definitions/genericError /metrics/actions/exportDeviceManufacturer: post: description: Exporta fabricantes do dispositivo para csv tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string description: Tenants responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: URL para download do arquivo CSV default: description: Error response schema: #/definitions/genericError /metrics/actions/updateAccessValidationMetricsConfig: post: description: Atualiza as configurações de métricas de validação de acesso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configs properties: configs: type: object allOf: – #/definitions/accessValidationMetricsConfig description: Configurações responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /metrics/actions/getAccessValidationMetricsConfig: post: description: Consulta as configurações de métricas de validação de acesso tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – configs properties: configs: type: object allOf: – #/definitions/accessValidationMetricsConfig description: Configurações default: description: Error response schema: #/definitions/genericError /metrics/actions/deleteAccessValidationMetrics: post: description: Apaga métricas de validação de acesso. É possível especificar quantidade de dados (em meses) que devem ser mantidos (baseado na data atual) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: olderThanMonths: type: integer format: int64 description: Quantidade de meses de dados que serão mantidos (a partir da data atual) responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN metricType: description: Tipo de métrica type: string enum: – PERSON_CREDENTIAL – VIRTUAL_CREDENTIAL – ACTIVE_DEVICES – CLOCKING – PERSON_CLOCKING – DEVICE_CLOCKING – ACCESS_CREDIT – ACCESS_VALIDATION – ACCESS – PERSON_ACCESS – DEVICE_ACCESS – CONFIGURATED_VALIDATIONS – STATISTICS – TREATED_INCIDENTS – COMPLETED_INCIDENTS – REGISTERED_INCIDENTS – STOPPED_INCIDENTS – ACTIVE_CAMERA – RECEIVED_ALARM – DEVICE_MANUFACTURER 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 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 metricData: description: Quantidade da data type: object required: – month – amount properties: month: type: string description: Data amount: type: number format: double description: Quantidade metricTenant: description: Dados do tenant type: object required: – tenant – metricData properties: tenant: type: string description: Tenant metricData: type: array items: type: object allOf: – #/definitions/metricData minimum: 1 description: Quantidade por data metricsInput: description: Filtro de métricas type: object required: – type properties: type: type: string allOf: – #/definitions/metricType description: Tipo de métrica tenants: type: array items: type: string description: Tenants initialDate: type: string description: Data inicial do período finalDate: type: string description: Data final do período searchMultipleMetricsInput: description: Filtro para buscar várias métricas type: object properties: metricTypes: type: array items: type: string allOf: – #/definitions/metricType description: Tipos de métricas tenants: type: array items: type: string description: Tenants initialDate: type: string description: Data inicial do período finalDate: type: string description: Data final do período configuredValidations: description: Validações configuradas type: object required: – tenant – permissionControl – levelControl – roleSuspensionControl – antiPassbackControl – accessCreditControl – slotTimeRoleControl – slotTimePhysicalControl – customValidationControl – betweenWorkDaysControl properties: tenant: type: string description: permissionControl: type: boolean description: levelControl: type: boolean description: roleSuspensionControl: type: boolean description: antiPassbackControl: type: boolean description: accessCreditControl: type: boolean description: slotTimeRoleControl: type: boolean description: slotTimePhysicalControl: type: boolean description: customValidationControl: type: boolean description: betweenWorkDaysControl: type: boolean description: metricStacked: description: Objeto para retornar os dados no padrão stacked para o frontend type: object required: – labels – metricStackedDatas properties: labels: type: array items: type: string minimum: 1 description: metricStackedDatas: type: array items: type: object allOf: – #/definitions/metricStackedData minimum: 1 description: metricStackedData: description: Objeto para organizar os dados no padrão stacked type: object required: – label – datas properties: label: type: string description: datas: type: array items: type: number format: double minimum: 1 description: accessValidationMetricsConfig: description: Configurações da validação de acesso type: object required: – sdkUrl – driverApiKey – cardNumbers – readersId properties: sdkUrl: type: string description: driverApiKey: type: string description: cardNumbers: type: array items: type: integer format: int64 minimum: 1 description: readersId: type: array items: type: integer format: int64 minimum: 1 description: 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. 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