trace

2.0info: 3.2.1 trace x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: trace contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /trace/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade 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 do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade 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 do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /trace/queries/getTrace: post: description: Retorna as informações de um rastreamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do objeto responses: 200: description: Ok schema: type: object required: – trace properties: trace: type: object allOf: – #/definitions/traceItem description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de um rastreamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do objeto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – trace properties: trace: type: object allOf: – #/definitions/traceItem description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /trace/queries/listTrace: post: description: Lista os rastreamentos existentes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – traces – listInformation properties: traces: type: array items: type: object allOf: – #/definitions/traceListItem minimum: 1 description: listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /trace/queries/getTraceExecution: post: description: Retorna as informações de uma execução de rastreamento assíncrono tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket da execução responses: 200: description: Ok schema: type: object required: – traceExecution properties: traceExecution: type: object allOf: – #/definitions/traceExecution description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de uma execução de rastreamento assíncrono tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket da execução in: query required: true type: string responses: 200: description: Ok schema: type: object required: – traceExecution properties: traceExecution: type: object allOf: – #/definitions/traceExecution description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /trace/queries/getUsageLimits: post: description: Retorna a lista de limites de uso definida tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – actAsFreeTier – usageLimit properties: actAsFreeTier: type: boolean description: Se verdadeiro, os limites fazem parte do pacote gratuito e excedente pode ser cobrado usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de limites de uso definida tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – actAsFreeTier – usageLimit properties: actAsFreeTier: type: boolean description: Se verdadeiro, os limites fazem parte do pacote gratuito e excedente pode ser cobrado usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /trace/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: 401: description: Invalid Credentials 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /trace/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials 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: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /trace/actions/saveTrace: post: description: Cria ou altera um rastreamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – name – projection properties: id: type: string description: Identificador no padrão trace://{tenant-domain}/{unique-identifier} name: type: string description: Nome projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Campos da projeção group: type: array items: type: string allOf: – #/definitions/field description: Campos que serão utilizados no agrupamento para contabilização de chamadas order: type: array items: type: object allOf: – #/definitions/orderField description: Campos que serão utilizados na ordenação do resultado filter: type: object allOf: – #/definitions/filter description: Filtro, utilize o discriminator simpleFilter responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do objeto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /trace/actions/deleteTrace: post: description: Deleta um rastreamento existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do objeto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /trace/actions/executeTrace: post: description: Executa um rastreamento, a quantidade de registros é limitada em número de registros (verificar limites em getUsageLimits), e 31 dias de periodo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – startDate – endDate properties: id: type: string description: Identificador do objeto startDate: type: string format: date-time description: Data de início a ser filtrado endDate: type: string format: date-time description: Data de fim a ser filtrado limit: type: integer format: int64 description: Limite de registros para serem retornados, utilizados para realização de previews.\n Este valor por padrão possui um limite que pode ser verificado na primitiva getUsageLimits. minimum: 1 responses: 200: description: Ok schema: type: object required: – headers – rows properties: headers: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Os campos da projeção rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: Os dados retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /trace/actions/executeTraceAsync: post: description: Executa um rastreamento, a quantidade de registros é limitada em número de registros (verificar limites em getUsageLimits), e 31 dias de período. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – startDate – endDate properties: id: type: string description: Identificador do objeto startDate: type: string format: date-time description: Data de início a ser filtrado endDate: type: string format: date-time description: Data de fim a ser filtrado limit: type: integer format: int64 description: Limite de registros para serem retornados, utilizados para realização de previews.\n Este valor por padrão possui um limite que pode ser verificado na primitiva getUsageLimits. minimum: 1 responses: 200: description: Ok schema: type: object required: – id – ticket properties: id: type: string description: Identificador do objeto ticket: type: string description: Ticket do processamento assíncrono. Use getTraceExecution para obter informações. 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN functionType: description: Tipo da função aplicada na projeção type: string enum: – COUNT – COUNT_DISTINCT field: description: Campos disponíveis na auditoria type: string enum: – USERNAME – SOURCE_DOMAIN – SOURCE_SERVICE – DESTINATION_DOMAIN – DESTINATION_SERVICE – PRIMITIVE – CONTEXT – DATE – TIME – STATUS – VERSION – CLIENT_IP orderType: description: Tipo da ordenação type: string enum: – ASC – DESC traceExecutionStatus: description: Status da execução type: string enum: – QUEUED – RUNNING – CANCELLED – DONE – ERROR 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 checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente projection: description: Projeção type: object required: – field properties: field: type: string allOf: – #/definitions/field description: Campo function: type: string allOf: – #/definitions/functionType description: Função opcional a ser aplicada orderField: description: Ordenação de um campo type: object required: – field – order properties: field: type: string allOf: – #/definitions/field description: Campo a ser ordenado order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação traceItem: description: type: object required: – name – projection – resource – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string description: Identificador do objeto name: type: string description: Nome projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Campos da projeção group: type: array items: type: string allOf: – #/definitions/field description: Campos que serão utilizados no agrupamento para contabilização de chamadas order: type: array items: type: object allOf: – #/definitions/orderField description: Campos que serão utilizados na ordenação do resultado filter: type: object allOf: – #/definitions/filter description: Filtro utilizado para criar o trace resource: type: string description: Resource of the trace createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Alterado por lastModifiedDate: type: string format: date-time description: Data da última alteração traceListItem: description: type: object required: – name – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string description: Identificador do objeto name: type: string description: Nome createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Alterado por lastModifiedDate: type: string format: date-time description: Data da última alteração filter: description: Filtro base de um trace discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: simpleFilter: description: Filtro simples, onde os atributos são verificados como E e os múltiplos valores como OU allOf: – #/definitions/filter – type: object required: – item properties: item: type: array items: type: object allOf: – #/definitions/simpleFilterItem minimum: 1 description: Item do filtro simpleFilterItem: description: Item do filtro do simples type: object required: – field – value properties: field: type: string allOf: – #/definitions/field description: Campo value: type: string description: Valor domainServiceFilter: description: Domínio e serviço para filtro type: object required: – domain – service properties: domain: type: string description: service: type: string description: row: description: Registro de uma consulta do dataset type: object required: – columns properties: columns: type: array items: type: string minimum: 1 description: Os valores das colunas na ordem da projeção usageLimit: description: Representa um limite de uso cadastrado type: object required: – label – key – limit – usage properties: label: type: string description: Descrição da propriedade cadastrada como limite key: type: string description: Chave identificadora do limite limit: type: integer format: int64 description: Quantidade máxima que pode ser atingida para o recurso usage: type: integer format: int64 description: Quantidade utilizada para o recurso pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As informações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas traceExecution: description: O estado de execução de um rastreio discriminator: _discriminator type: object required: – status – startDate – _discriminator properties: status: type: string allOf: – #/definitions/traceExecutionStatus description: Status da execução startDate: type: string format: date-time description: Data de início da execução _discriminator: type: string description: errorTraceExecution: description: Registro de execução do rastreamento com erro allOf: – #/definitions/traceExecution – type: object required: – endDate properties: message: type: string description: Mensagem de erro endDate: type: string format: date-time description: Data de fim da execução doneTraceExecution: description: Registro de execução do rastreamento com sucesso allOf: – #/definitions/traceExecution – type: object required: – location – projection – endDate properties: location: type: string description: Localização do arquivo gerado projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Projeção da consulta endDate: type: string format: date-time description: Data de fim da execução 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