2.0info: 2.1.0 Data Studio description: Responsável pelo gerenciamento de dashboards analíticos e execução de consultas na plataforma Data Studio. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: data_studio 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: /data_studio/queries/getDashboard: post: description: Busca um dashboard completo pelo seu identificador, retornando todos os componentes e status 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 dashboard responses: 200: description: Ok schema: type: object allOf: – #/definitions/dashboardOutput 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: Dashboard não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca um dashboard completo pelo seu identificador, retornando todos os componentes e status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do dashboard in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/dashboardOutput 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: Dashboard não encontrado default: description: Error response schema: #/definitions/genericError /data_studio/queries/listDashboards: post: description: Lista os dashboards existentes de forma paginada, ordenados pelas informações mais recentes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pagination responses: 200: description: Ok schema: type: object required: – dashboards – listInformation properties: dashboards: type: array items: type: object allOf: – #/definitions/simplifiedDashboard minimum: 1 description: Dashboards retornados na página consultada listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o total de resultados e páginas 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 get: description: Lista os dashboards existentes de forma paginada, ordenados pelas informações mais recentes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dashboards – listInformation properties: dashboards: type: array items: type: object allOf: – #/definitions/simplifiedDashboard minimum: 1 description: Dashboards retornados na página consultada listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o total de resultados e páginas 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 /data_studio/queries/validateDashboardName: post: description: Verifica se um nome pode ser usado em um novo dashboard, ou seja, se ainda não existe outro dashboard com o mesmo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do dashboard a ser validado responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Indica se o nome é válido (true quando nenhum dashboard usa o nome informado) 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 get: description: Verifica se um nome pode ser usado em um novo dashboard, ou seja, se ainda não existe outro dashboard com o mesmo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome do dashboard a ser validado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Indica se o nome é válido (true quando nenhum dashboard usa o nome informado) 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 /data_studio/queries/execute: post: description: Executa uma consulta SQL customizada aplicando filtros, ordenações e limite de registros, retornando colunas e linhas de resultado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sql properties: filters: type: array items: type: object allOf: – #/definitions/filterValue description: Filtros aplicados na execução da consulta orders: type: array items: type: object allOf: – #/definitions/orderValue description: Ordenações aplicadas na execução da consulta sql: type: string description: Consulta SQL a ser executada maxRows: type: integer format: int64 description: Quantidade máxima de registros a serem retornados minimum: 1 maximum: 1000 default: 1000 responses: 200: description: Ok schema: type: object required: – columns – rows – totalElements properties: columns: type: array items: type: object allOf: – #/definitions/column minimum: 1 description: Colunas do resultado da consulta rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: Linhas do resultado da consulta totalElements: type: integer format: int64 description: Quantidade total de registros encontrados 401: description: Invalid Credentials 400: description: Requisição inválida, SQL informado incorretamente ou parâmetros obrigatórios não informados 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /data_studio/queries/extractMetadata: post: description: Extrai a lista de colunas e seus tipos a partir da estrutura de uma consulta SQL, sem executá-la tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sql properties: sql: type: string description: Consulta SQL a ter os metadados extraídos responses: 200: description: Ok schema: type: object required: – columns properties: columns: type: array items: type: object allOf: – #/definitions/column minimum: 1 description: Colunas identificadas na consulta 401: description: Invalid Credentials 400: description: Requisição inválida, SQL informado incorretamente ou parâmetros obrigatórios não informados 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Extrai a lista de colunas e seus tipos a partir da estrutura de uma consulta SQL, sem executá-la tags: – Queries x-senior-visibility: PRIVATE parameters: – name: sql description: Consulta SQL a ter os metadados extraídos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – columns properties: columns: type: array items: type: object allOf: – #/definitions/column minimum: 1 description: Colunas identificadas na consulta 401: description: Invalid Credentials 400: description: Requisição inválida, SQL informado incorretamente ou parâmetros obrigatórios não informados 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /data_studio/queries/listMasterDatas: post: description: Lista os master datas disponíveis para uso em dashboards tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: type: array items: type: object allOf: – #/definitions/masterData minimum: 1 description: Master datas disponíveis 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os master datas disponíveis para uso em dashboards tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: type: array items: type: object allOf: – #/definitions/masterData minimum: 1 description: Master datas disponíveis 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /data_studio/queries/getMasterDatasMetadata: post: description: Retorna a definição de metadados (colunas e semântica) para uma ou mais master datas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: names: type: array items: type: string description: Nomes das master datas para retornar metadados; se não informado, retorna de todas responses: 200: description: Ok schema: type: object required: – masterDatasMetadata properties: masterDatasMetadata: type: array items: type: object allOf: – #/definitions/masterDataMetadata minimum: 1 description: Metadados dos master datas solicitadas 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: Master data não encontrada default: description: Error response schema: #/definitions/genericError /data_studio/queries/getAgentStatus: post: description: Consulta o estado atual de um agendamento pelo seu identificador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – executionId properties: executionId: type: string description: Identificador do agendamento retornado por executeAgent responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/agentExecutionStatus description: Estado atual (PROCESSING/ERROR/COMPLETED) 401: description: Invalid Credentials 400: description: Requisição inválida 403: description: Permissão negada 404: description: Execução não encontrada default: description: Error response schema: #/definitions/genericError get: description: Consulta o estado atual de um agendamento pelo seu identificador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: executionId description: Identificador do agendamento retornado por executeAgent in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/agentExecutionStatus description: Estado atual (PROCESSING/ERROR/COMPLETED) 401: description: Invalid Credentials 400: description: Requisição inválida 403: description: Permissão negada 404: description: Execução não encontrada default: description: Error response schema: #/definitions/genericError /data_studio/queries/getPublishedDashboard: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/publishedDashboard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/publishedDashboard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_studio/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 /data_studio/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 /data_studio/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_studio/actions/createDashboard: post: description: Cria um novo dashboard com seus filtros, widgets e master datas associados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/dashboard responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do dashboard criado 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 /data_studio/actions/updateDashboard: post: description: Atualiza um dashboard existente, sobrescrevendo seus filtros, widgets e master datas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/dashboardEntry 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: Dashboard não encontrado default: description: Error response schema: #/definitions/genericError /data_studio/actions/deleteDashboard: post: description: Remove um dashboard 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 dashboard a ser removido responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_studio/actions/publishDashboard: post: description: Publica um dashboard, tornando-o disponível para consumo público via widgets publicados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dashboardId properties: dashboardId: type: string description: Identificador do dashboard a ser publicado responses: 200: description: Ok schema: type: object required: – publicationId – dashboardId properties: publicationId: type: string description: Identificador da publicação gerada dashboardId: type: string description: Identificador do dashboard publicado 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: Dashboard não encontrado default: description: Error response schema: #/definitions/genericError /data_studio/actions/executePublishedWidget: post: description: Executa um widget de um dashboard publicado, aplicando filtros e ordenações, e retorna seus dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – publishedWidgetId properties: publishedWidgetId: type: string description: Identificador do widget publicado a ser executado filters: type: array items: type: object allOf: – #/definitions/filterValue description: Filtros aplicados na execução do widget orders: type: array items: type: object allOf: – #/definitions/orderValue description: Ordenações aplicadas na execução do widget responses: 200: description: Ok schema: type: object required: – columns – rows – totalElements properties: columns: type: array items: type: object allOf: – #/definitions/column minimum: 1 description: Colunas do resultado da execução do widget rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: Linhas do resultado da execução do widget totalElements: type: integer format: int64 description: Quantidade total de registros encontrados 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: Widget publicado não encontrado default: description: Error response schema: #/definitions/genericError /data_studio/actions/executeAgent: post: description: Agenda a execução assíncrona do agente de IA para geração de um novo dashboard.\nO worker consome a fila, chama a Sara Agentes e persiste o rascunho ao final.\nRetorna imediatamente com o identificador do agendamento.\n## Resource:\n- res://senior.com.br/platform/authorization/resource (Save)\n- res://senior.com.br/platform/data_studio/editable_dashboard (Create) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – prompt properties: prompt: type: string description: Prompt em linguagem natural descrevendo o dashboard desejado masterDatas: type: array items: type: string description: Lista do nome dos master datas utilizados como filtro para o contexto de geração responses: 200: description: Ok schema: type: object required: – executionId properties: executionId: type: string description: Identificador único do agendamento – usado para consulta via getAgentStatus 401: description: Invalid Credentials 400: description: Requisição inválida: prompt vazio ou parâmetro obrigatório ausente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericErrordefinitions: filterType: type: string enum: – TEXT – INTEGER – DATE description: Tipo de dado suportado por um filtro: * `TEXT` – Filtro do tipo texto * `INTEGER` – Filtro do tipo inteiro * `DATE` – Filtro do tipo data orderDirection: type: string enum: – ASC – DESC description: Direção de ordenação suportada: * `ASC` – Crescente * `DESC` – Decrescente dashboardStatus: type: string enum: – DRAFT – PUBLISHED description: Status possíveis de um dashboard: * `DRAFT` – Dashboard em rascunho * `PUBLISHED` – Dashboard publicado agentExecutionStatus: type: string enum: – QUEUED – PROCESSING – COMPLETED – ERROR description: Estado de um agendamento de geração de dashboard via IA.: * `QUEUED` – Aguardando ser executado * `PROCESSING` – Agente executando a geração * `COMPLETED` – Geração concluída com sucesso; rascunho criado * `ERROR` – Geração encerrada em falha userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim dashboardComponent: description: Componente base de um dashboard (filter ou widget) discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: filter: description: Filtro aplicado a um dashboard, permitindo restringir os dados exibidos nos widgets allOf: – #/definitions/dashboardComponent – type: object required: – name – type – label properties: name: type: string description: Nome interno do filtro type: type: string allOf: – #/definitions/filterType description: Tipo de dado do filtro label: type: string description: Rótulo de apresentação do filtro value: type: string format: byte description: Valor selecionado no filtro filterEntry: description: allOf: – #/definitions/filter – type: object required: – id properties: id: type: string description: Identificador único do filtro widget: description: Widget de um dashboard responsável por visualizar dados através de uma consulta SQL allOf: – #/definitions/dashboardComponent – type: object required: – type – title – layout properties: type: type: string description: Tipo do widget (ex: bar, line, pie, table) type: string description: Título do widget description: type: string description: Descrição do widget layout: type: object allOf: – #/definitions/widgetLayout description: Posição e dimensões do widget no dashboard configuration: type: string format: byte description: Configuração livre do widget, dependente do tipo editableWidget: description: Widget com informação da consulta sendo realizada allOf: – #/definitions/widget – type: object properties: sql: type: string description: Consulta SQL executada pelo widget editableWidgetEntry: description: Widget com identificador e a consulta sendo realizada allOf: – #/definitions/editableWidget – type: object required: – id properties: id: type: string description: Identificador único do widget publishedWidgetEntry: description: Widget publicado com o identificador allOf: – #/definitions/widget – type: object required: – id properties: id: type: string description: Identificador único do widget widgetLayout: description: Layout que posiciona e dimensiona um widget dentro do dashboard type: object required: – x – y – width – height properties: x: type: integer format: int64 description: Coordenada X (posição horizontal) do widget no grid y: type: integer format: int64 description: Coordenada Y (posição vertical) do widget no grid width: type: number format: double description: Largura ocupada pelo widget no grid height: type: number format: double description: Altura ocupada pelo widget no grid pagination: description: 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 minimum: 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 listInformation: description: Informações sobre os resultados de uma listagem paginada 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 dashboardCore: description: Componente com campos compatilhados dos dashboards discriminator: _discriminator type: object required: – name – _discriminator properties: name: type: string description: Nome do dashboard description: type: string description: Descrição do dashboard filters: type: array items: type: object allOf: – #/definitions/filter description: Filtros do dashboard _discriminator: type: string description: dashboard: description: Estrutura Dashboard editável (DRAFT), sem identificador allOf: – #/definitions/dashboardCore – type: object required: – widgets properties: widgets: type: array items: type: object allOf: – #/definitions/editableWidget minimum: 1 description: Widgets do dashboard editável masterDatas: type: array items: type: string description: Master datas referenciadas pelo dashboard aiGenerationPrompt: type: string description: Prompt utilizado para geração do dashboard por IA (quando aplicável) dashboardEntry: description: Dashboard editável com identificador, usado em operações de atualização e leitura allOf: – #/definitions/dashboard – type: object required: – id properties: id: type: string description: Identificador do dashboard dashboardOutput: description: Dashboard retornado nas operações de consulta, incluindo status atual allOf: – #/definitions/dashboardEntry – type: object required: – status properties: status: type: string allOf: – #/definitions/dashboardStatus description: Status atual do dashboard (rascunho ou publicado) publishedDashboard: description: Dashboard publicado com identificador allOf: – #/definitions/dashboardCore – type: object required: – id – widgets properties: id: type: string description: widgets: type: array items: type: object allOf: – #/definitions/publishedWidgetEntry minimum: 1 description: filterValue: description: Valor aplicado a um filtro na execução de uma consulta ou widget type: object required: – name – type properties: name: type: string description: Nome do filtro type: type: string allOf: – #/definitions/filterType description: Tipo do filtro value: type: string format: byte description: Valor a ser aplicado no filtro orderValue: description: Ordenação aplicada a uma consulta ou widget type: object required: – field – direction properties: field: type: string description: Nome do campo a ser ordenado direction: type: string allOf: – #/definitions/orderDirection description: Direção da ordenação column: description: Coluna retornada pela execução de uma consulta type: object required: – name – type properties: name: type: string description: Nome da coluna type: type: string description: Tipo da coluna row: description: Linha de resultado da execução de uma consulta type: object required: – values properties: values: type: string format: byte description: Valores das colunas na linha, indexados pelo nome da coluna masterData: description: Master data disponível para uso em dashboards type: object required: – name – description properties: name: type: string description: Nome da master data description: type: string description: Descrição da master data simplifiedDashboard: description: Versão resumida de um dashboard, usada em listagens type: object required: – id – name – status – createdBy – createdAt – updatedAt – lastPublished properties: id: type: string description: Identificador do dashboard name: type: string description: Nome do dashboard description: type: string description: Descrição do dashboard status: type: string allOf: – #/definitions/dashboardStatus description: Status atual do dashboard createdBy: type: string description: Usuário que criou o dashboard createdAt: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de criação do dashboard updatedAt: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data da última atualização do dashboard lastPublished: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data da última publicação do dashboard publishedDashboardId: type: string description: Identificador da publicação do dashboard. Nulo quando não for publicado. masterDataMetadata: description: Metadados de uma master data, incluindo semântica e colunas type: object required: – name – tableName – fullTableName – description – semanticDescription – columns properties: name: type: string description: Nome da master data tableName: type: string description: Nome da tabela associada fullTableName: type: string description: Nome completo da tabela associada description: type: string description: Descrição da master data semanticDescription: type: string description: Descrição semântica utilizada para geração assistida por IA columns: type: array items: type: object allOf: – #/definitions/masterDataColumn minimum: 1 description: Colunas da master data masterDataColumn: description: Definição de uma coluna de master data type: object required: – name – type – description properties: name: type: string description: Nome da coluna type: type: string description: Tipo da coluna description: type: string description: Descrição da coluna 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage