2.0info: 2.26.2 Banco de dados dos relatórios description: Service that manages and generates database for reports x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: report_database 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /report_database/queries/getDatabaseInformation: post: description: Retorna as informações sobre a base de dados do tenant utilizada pelos relatórios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant. Caso não informado é assumido o tenant do usuário que realizou a requisição callTeiid: type: boolean description: Força a chamada no teiid para consultar o status, por padrão tenta buscar do cache. Se o cache ainda não existir ou a data da última atualização foi antiga, é feita a chamada no teiid. default: false responses: 200: description: Ok schema: type: object required: – tenantName – status – lastVerification properties: tenantName: type: string description: Nome do tenant status: type: string allOf: – #/definitions/databaseStatus description: O status da base de dados processingStartDate: type: string format: date-time description: Data de início do processo de atualização se houver lastSuccessfulRefresh: type: string format: date-time description: Data da última atualização bem sucedida da base de dados lastVerification: type: string format: date-time description: Data da última verificação do status services: type: array items: type: object allOf: #/definitions/domainService description: Serviços que fazem parte da base de dados default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações sobre a base de dados do tenant utilizada pelos relatórios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantName description: O nome do tenant. Caso não informado é assumido o tenant do usuário que realizou a requisição in: query type: string – name: callTeiid description: Força a chamada no teiid para consultar o status, por padrão tenta buscar do cache. Se o cache ainda não existir ou a data da última atualização foi antiga, é feita a chamada no teiid. in: query type: boolean responses: 200: description: Ok schema: type: object required: – tenantName – status – lastVerification properties: tenantName: type: string description: Nome do tenant status: type: string allOf: – #/definitions/databaseStatus description: O status da base de dados processingStartDate: type: string format: date-time description: Data de início do processo de atualização se houver lastSuccessfulRefresh: type: string format: date-time description: Data da última atualização bem sucedida da base de dados lastVerification: type: string format: date-time description: Data da última verificação do status services: type: array items: type: object allOf: #/definitions/domainService description: Serviços que fazem parte da base de dados default: description: Error response schema: #/definitions/genericError /report_database/queries/listDatabaseInformation: post: description: Retorna o estado da base de dados dos tenants e informações de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do tenant status: type: string allOf: – #/definitions/databaseStatus description: O estado da base que deseja filtrar 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: – listInformation – tenantDatabaseInformations properties: listInformation: type: object allOf: #/definitions/listInformation description: Informações sobre os resultados da listagem tenantDatabaseInformations: type: array items: type: object allOf: #/definitions/tenantDatabaseInformation minimum: 1 description: Os elementos retornados pela listagem default: description: Error response schema: #/definitions/genericError /report_database/queries/listCloudDatabases: post: description: Lista os bancos de dados disponíveis para esse tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Tenant do qual se deseja recuperar os bancos de dados disponíveis responses: 200: description: Ok schema: type: object required: – databases properties: databases: type: array items: type: object allOf: #/definitions/database minimum: 1 description: Bancos de dados disponíveis para o tenant informado default: description: Error response schema: #/definitions/genericError get: description: Lista os bancos de dados disponíveis para esse tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant do qual se deseja recuperar os bancos de dados disponíveis in: query required: true type: string responses: 200: description: Ok schema: type: object required: – databases properties: databases: type: array items: type: object allOf: #/definitions/database minimum: 1 description: Bancos de dados disponíveis para o tenant informado default: description: Error response schema: #/definitions/genericError /report_database/queries/listCloudDbEngineVersions: post: description: Lista as versões do banco de dados suportadas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – versions properties: versions: type: array items: type: string minimum: 1 description: Versões do banco de dados suportadas default: description: Error response schema: #/definitions/genericError get: description: Lista as versões do banco de dados suportadas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – versions properties: versions: type: array items: type: string minimum: 1 description: Versões do banco de dados suportadas default: description: Error response schema: #/definitions/genericError /report_database/queries/listCloudDbInstanceTypes: post: description: Lista os tipos de instância disponíveis para a versão do banco requisitada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – engineVersion properties: engineVersion: type: string description: Versão do banco para qual se deseja verificar os tipos de instância responses: 200: description: Ok schema: type: object required: – instanceTypes properties: instanceTypes: type: array items: type: string minimum: 1 description: Tipos de instâncias disponíveis default: description: Error response schema: #/definitions/genericError get: description: Lista os tipos de instância disponíveis para a versão do banco requisitada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: engineVersion description: Versão do banco para qual se deseja verificar os tipos de instância in: query required: true type: string responses: 200: description: Ok schema: type: object required: – instanceTypes properties: instanceTypes: type: array items: type: string minimum: 1 description: Tipos de instâncias disponíveis default: description: Error response schema: #/definitions/genericError /report_database/queries/listReplicationInstances: post: description: Lista as instâncias de replicações disponíveis na conta configurada da nuvem tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – replicationInstances properties: replicationInstances: type: array items: type: string minimum: 1 description: Instâncias de replicações disponíveis default: description: Error response schema: #/definitions/genericError get: description: Lista as instâncias de replicações disponíveis na conta configurada da nuvem tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – replicationInstances properties: replicationInstances: type: array items: type: string minimum: 1 description: Instâncias de replicações disponíveis default: description: Error response schema: #/definitions/genericError /report_database/queries/listTables: post: description: Lists the existing database tables tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: #/definitions/tableName minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Lists the existing database tables tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: #/definitions/tableName minimum: 1 description: default: description: Error response schema: #/definitions/genericError /report_database/queries/getTableMetadata: post: description: Gets the definition of a table tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tableId properties: tableId: type: string description: The table id responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: object allOf: #/definitions/tableMetadata description: The table definition default: description: Error response schema: #/definitions/genericError get: description: Gets the definition of a table tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tableId description: The table id in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: object allOf: #/definitions/tableMetadata description: The table definition default: description: Error response schema: #/definitions/genericError /report_database/queries/getTableByName: post: description: Gets the id and display name of a table tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – schema properties: name: type: string description: Name of the table schema: type: string description: schema of the table responses: 200: description: Ok schema: type: object required: – table properties: table: type: object allOf: #/definitions/tableName description: The details of the table default: description: Error response schema: #/definitions/genericError get: description: Gets the id and display name of a table tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Name of the table in: query required: true type: string – name: schema description: schema of the table in: query required: true type: string responses: 200: description: Ok schema: type: object required: – table properties: table: type: object allOf: #/definitions/tableName description: The details of the table default: description: Error response schema: #/definitions/genericError /report_database/queries/listMetadataTable: post: description: Obtém a lista de todos os metadados cujo nome, nome traduzido, serviço, domínio, ou descrições contenham o valor pesquisado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome, nome traduzido, serviço, domínio, ou descrições dos metadatados das tabelas schema: type: string description: Busca os metadados das tabelas que contém o nome do schema informado table: type: string description: Busca os metadados das tabelas que contém o nome da tabela informado 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: – tables – listInformation properties: tables: type: array items: type: object allOf: #/definitions/completeMetadataTable minimum: 1 description: Os elementos retornados pela listagem listInformation: type: object allOf: #/definitions/listInformation description: Informações sobre os resultados da listagem default: description: Error response schema: #/definitions/genericError /report_database/queries/exportMetadataTable: post: description: Exporta os metadados de todas as views tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: exportType: type: string allOf: – #/definitions/exportType description: Tipo da exportação, sendo o default o CSV_FORMATTED responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL do arquivo gerado default: description: Error response schema: #/definitions/genericError /report_database/queries/getResourcesByTable: post: description: Obtém uma lista de permissões filtrando por schema e tabela tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tables properties: tables: type: array items: type: object allOf: #/definitions/tableSchema minimum: 1 description: Filtros de schema e tabela responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: #/definitions/permission minimum: 1 description: Lista de permissões default: description: Error response schema: #/definitions/genericError /report_database/queries/listAllTablesWithTheirColumns: post: description: Obtém a lista de tabelas e suas respectivas colunas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: #/definitions/tableInfo minimum: 1 description: Lista de tabelas com suas respectivas colunas default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista de tabelas e suas respectivas colunas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: #/definitions/tableInfo minimum: 1 description: Lista de tabelas com suas respectivas colunas default: description: Error response schema: #/definitions/genericError /report_database/queries/findSchemas: post: description: Busca uma lista de schemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Texto para busca responses: 200: description: Ok schema: type: object required: – schemas properties: schemas: type: array items: type: string minimum: 1 description: Lista de schemas default: description: Error response schema: #/definitions/genericError get: description: Busca uma lista de schemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: search description: Texto para busca in: query type: string responses: 200: description: Ok schema: type: object required: – schemas properties: schemas: type: array items: type: string minimum: 1 description: Lista de schemas default: description: Error response schema: #/definitions/genericError /report_database/queries/findTables: post: description: Busca uma lista de tabelas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schema properties: search: type: string description: Texto para busca schema: type: string description: Schema para filtrar responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: string minimum: 1 description: Lista de tabelas default: description: Error response schema: #/definitions/genericError get: description: Busca uma lista de tabelas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: search description: Texto para busca in: query type: string – name: schema description: Schema para filtrar in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: string minimum: 1 description: Lista de tabelas default: description: Error response schema: #/definitions/genericError /report_database/queries/findColumns: post: description: Busca uma lista de colunas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schema – table properties: search: type: string description: Texto para busca schema: type: string description: Schema para filtrar table: type: string description: Tabela para filtrar responses: 200: description: Ok schema: type: object required: – columns properties: columns: type: array items: type: string minimum: 1 description: Lista de colunas default: description: Error response schema: #/definitions/genericError get: description: Busca uma lista de colunas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: search description: Texto para busca in: query type: string – name: schema description: Schema para filtrar in: query required: true type: string – name: table description: Tabela para filtrar in: query required: true type: string responses: 200: description: Ok schema: type: object required: – columns properties: columns: type: array items: type: string minimum: 1 description: Lista de colunas default: description: Error response schema: #/definitions/genericError /report_database/queries/getSourceDatabaseMetadata: post: description: Busca os metadados da base de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – domain – service properties: tenant: type: string description: Nome do tenant domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: object allOf: #/definitions/sourceDatabaseMetadata description: default: description: Error response schema: #/definitions/genericError get: description: Busca os metadados da base de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Nome do tenant in: query required: true type: string – name: domain description: Domínio do serviço in: query required: true type: string – name: service description: Nome do serviço in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: object allOf: #/definitions/sourceDatabaseMetadata description: default: description: Error response schema: #/definitions/genericError /report_database/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 /report_database/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 /report_database/actions/removeDatabase: post: description: Remove a base de dados do tenant utilizada pelos relatórios. Os valores das configurações de conexão que estão definidas para essa base de dados (reportdb.url e reportdb.db_type) também serão removidos. Essa operação será executada de maneira assíncrona. O usuário que chamou a primitiva receberá uma notificação informando o sucesso ou erro da remoção. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant que terá a base de dados removida. Caso não informado é assumido o tenant do usuário que realizou a requisição responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /report_database/actions/composeDatabase: post: description: Cria/Recria a base de dados do tenant para ser utilizado pelos relatórios. Os valores das configurações de conexão do tenant para esse serviço (reportdb.url e reportdb.db_type) serão definidos para a base de dados criada. A base de dados criada será uma composição das múltiplas base de dados dos serviços participantes. Os serviços que participarão da da base de dados para relatório serão aqueeles que disponibilizarem um arquivo de metadados `report-config.json` contendo as informações para a conexão com a sua base de dados. Cada serviço participante terá as `VIEWS` da sua base de dados disponiveis no schema ` dominio – servico ` criado na base de dados do relatório. Essa operação será executada de maneira assíncrona. O usuário que chamou a primitiva receberá uma notificando informando o sucesso ou erro da criação. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant que deve ter a base de dados de relatórios criada/recriada. Caso não informado é assumido o tenant do usuário que realizou a requisição cloudDatabase: type: string description: Banco de dados na nuvem para onde se deseja fazer a replicação dos dados replicationInstance: type: string description: Instância a ser utilizada para replicar os dados responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /report_database/actions/refreshDatabase: post: description: Atualiza as informações da base de dados do tenant utilizada pelos relatórios. Os serviços participantes da base de dados não serão alterados, apenas as informações de dados e metadados serão atualizadas. Caso alguma das bases de dados dos serviços participantes apresente problemas, torne-inválida ou cause um erro geral na atualização, a base de dados do tenant será marcada como indisponível e será necessário criar a base (composeDatabase) novamente. Essa operação será executada de maneira assíncrona. O usuário que chamou a primitiva receberá uma notificando informando o sucesso ou erro da criação/atualização. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant que deve ter a base de dados de relatórios atualizada. Caso não informado é assumido o tenant do usuário que realizou a requisição services: type: array items: type: object allOf: #/definitions/refreshService description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /report_database/actions/createCloudDatabase: post: description: Cria um novo banco de dados na nuvem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – instanceType – publicAccessible – multiAZ – username – password – dbName – dbVersion – allocatedStorage properties: name: type: string description: Nome da instância na nuvem instanceType: type: string description: Tipo da instância na nuvem publicAccessible: type: boolean description: Define se será permitido o acesso fora da rede da nuvem tenant: type: string description: Nome do tenant para qual se deseja criar o banco de dados. Se o valor for null poderá ser utilizado por todos os tenants multiAZ: type: boolean description: Define se o banco será criada em múltiplas zonas de disponibilidade username: type: string description: Nome de usuário para acesso ao banco de dados password: type: string description: Senha para acesso ao banco de dados dbName: type: string description: Nome do banco de dados dbVersion: type: string description: Versão do banco de dados allocatedStorage: type: integer format: int64 description: Tamanho de armazenamento disponível para o banco minimum: 20 maximum: 16384 responses: 200: description: Ok schema: type: object required: – dbInstanceIdentifier properties: dbInstanceIdentifier: type: string description: Identificador da instância na nuvem default: description: Error response schema: #/definitions/genericError /report_database/signals/forceUpdateDatabaseStatus: post: description: Força a atualização do status da base de dados do tenant via signal, enviando uma notificação após o processo ser concluído tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant. Caso não informado é assumido o tenant do usuário que realizou a requisição callTeiid: type: boolean description: Força a chamada no teiid para consultar o status, por padrão tenta buscar do cache. Se o cache ainda não existir ou a data da última atualização foi antiga, é feita a chamada no teiid. default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /report_database/signals/importMetadata: post: description: Imports the metadata of the reporting database tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenantName: type: string description: O nome do tenant que deve ter os metadados sincronizados. Caso não informado é assumido o tenant do usuário que realizou a requisição responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /report_database/signals/importTranslations: post: description: Importa um bundle de traduções tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – url – language properties: url: type: string description: URL das traduções language: type: string description: Linguagem das traduções global: type: boolean description: Importar para todos os tenants default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /report_database/signals/exportTranslations: post: description: Exporta um bundle de traduções tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – language properties: language: type: string description: Linguagem das traduções responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: databaseStatus: description: Os status possíveis de uma base de dados de relatório type: string enum: – INEXISTENT – AVAILABLE – UNAVAILABLE – FAILED exportType: description: Os tipos de exportação dos metadados existentes type: string enum: – CSV_FORMATTED – CSV_UNFORMATTED columnType: description: Tipo da coluna type: string enum: – StringType – IntegerType – DatetimeType – BooleanType – DateType – InvalidType – DecimalType – TimeType lookupFieldType: description: Tipo do dado do campo no serviço do origem type: string enum: – INTEGER – STRING 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 database: description: Banco de dados hospedado na nuvem type: object required: – name – instanceType – dbVersion – database properties: name: type: string description: Nome do banco de dados instanceType: type: string description: Tipo da instância do banco tenant: type: string description: Tenant para o qual o banco está configurado. Se o valor for null o tenant é de uso geral dbVersion: type: string description: Versão do banco de dados database: type: string description: Banco de dados. Atualmente é suportado apenas Postgres tableSchema: description: Registro para trazer uma lista dos nomes das tabelas e respectivos schema type: object required: – table – schema properties: table: type: string description: Nome da tabela schema: type: string description: Nome do schema da tabela completeMetadataTable: description: Informações completas dos metadados das tabelas type: object required: – domainName – serviceName – schema – name properties: domainName: type: string description: Domínio serviceName: type: string description: Serviço schema: type: string description: Schema name: type: string description: Nome da tabela displayName: type: string description: Nome da tabela traduzido longDescription: type: string description: Descrição longa shortDescription: type: string description: Descrição curta columns: type: array items: type: object allOf: #/definitions/completeMetadataColumn description: As colunas da tabela resourceUri: type: string description: URI do recurso da tabela completeMetadataColumn: description: Informações completas dos metadados das colunas type: object required: – name – dataType properties: name: type: string description: Nome da coluna displayName: type: string description: Nome da coluna traduzido dataType: type: string description: Tipo do dado customField: type: string description: Nome do campo customizado, ou vazio se não for longDescription: type: string description: Descrição longa shortDescription: type: string description: Descrição curta lookupPrimitive: type: object allOf: #/definitions/columnLookupPrimitive description: Primitiva utilizada para obter os valores dessa coluna lookupData: type: object allOf: #/definitions/lookupData description: Dados relacionados a primitiva utilizada para obter os valores dessa coluna domainService: description: Domínio e serviço type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio serviceName: type: string description: Serviço success: type: boolean description: Se foi possível incluir o serviço na criação do vdb default: true reason: type: string description: Em caso de erro, qual o motivo, campo internacionalizado refreshService: description: type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio serviceName: type: string description: Serviço serviceName: description: type: object required: – domain – service properties: domain: type: string description: Domínio service: type: string description: Serviço tableName: description: Represents a table name type: object required: – id – name – displayName – schemaDisplayName – schema properties: id: type: string maxLength: 32 description: ID of this table name: type: string maxLength: 128 description: Name of this table displayName: type: string maxLength: 128 description: Display Name of this table. This value is language dependent schemaDisplayName: type: string maxLength: 128 description: Display name of the schema. This value is language dependent schema: type: string maxLength: 100 description: Name of the schema where the table is located resourceUri: type: string maxLength: 255 description: URI do recurso da tabela tableMetadata: description: Represents a metadata of a table type: object required: – id – tableName – displayName – columns properties: id: type: string description: Id of this table metadata tableName: type: string description: Name of this table displayName: type: string description: Display name of this table (i18n) resourceUri: type: string description: URI do recurso da tabela columns: type: array items: type: object allOf: #/definitions/queryMetadataColumn minimum: 1 description: Columns of this table queryMetadataColumn: description: Represents a metadata of a query column type: object required: – sequence – name – displayName – type – isPrimaryKey – isNullable – sqlOrder – isSortable – isSearchable – isAggregatable – isCustom properties: sequence: type: integer format: int64 description: Order of this column in the result data name: type: string description: Name of this column displayName: type: string description: Display name of this column – i18n type: type: string allOf: – #/definitions/columnType description: Type of this column isPrimaryKey: type: boolean description: Indicates if this column is part of the table primary key isNullable: type: boolean description: Indicates is this column is nullable sqlOrder: type: integer format: int64 description: Order of this column in the result query isSortable: type: boolean description: Whether this column can be sorted or not isSearchable: type: boolean description: Whether this column can be used in filters or not isAggregatable: type: boolean description: Whether this column can be used in aggregations or not isCustom: type: boolean description: Whether this column is a custom field or not lookupPrimitive: type: object allOf: #/definitions/columnLookupPrimitive description: Primitiva utilizada para obter os valores dessa coluna lookupData: type: object allOf: #/definitions/lookupData description: Dados relacionados a primitiva utilizada para obter os valores dessa coluna lookupFieldData: description: Dados relacionado a um campo utilizado na pesquisa type: object required: – fieldName – type properties: fieldName: type: string description: Nome do campo type: type: string allOf: – #/definitions/lookupFieldType description: Tipo do campo columnLookupPrimitive: description: Primitiva utilizada para obter os valores de uma coluna type: object required: – domain – service – primitive properties: domain: type: string description: Domínio do serviço da primitiva service: type: string description: Serviço da primitiva primitive: type: string description: Primitiva que deve ser utilizada para buscar os valores do parâmetro lookupData: description: Entitdade utilizada para obter os valores de uma coluna type: object required: – domain – service – entity – displayFields – searchFields properties: domain: type: string description: Domínio do serviço da primitiva service: type: string description: Serviço da primitiva entity: type: string description: Entidade que deve ser utilizada para buscar os valores do parâmetro displayFields: type: array items: type: object allOf: #/definitions/lookupFieldData minimum: 1 description: Campos que serão exibidos para o usuário ao usar editor visual, esses campos não contém entidades aninhadas, assim impedindo o uso de queries com joins nos serviços origem do campo e são exibidos sem qualquer tratamento ao usuário searchFields: type: array items: type: object allOf: #/definitions/lookupFieldData minimum: 1 description: Campos que serão utilizados na pesquisa pelo lookup ao usar editor visual, esses campos não contém entidades aninhadas, assim impedindo o uso de queries com joins nos serviços origem do campo filterField: type: object allOf: #/definitions/lookupFieldData description: Campo que será utilizado no filtro da visão dinâmica ao executá-la, esse campo não contém entidades aninhadas, assim impedindo o uso de queries com joins nos serviços origem do campo 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 permission: description: Representa uma permissão type: object required: – resource – action properties: resource: type: string description: URI do recurso action: type: string description: Ação do recurso tenantDatabaseInformation: description: Informações da base de dados de um tenant type: object required: – tenantName – status – lastStatusVerification – processInProgress properties: tenantName: type: string description: Nome do tenant status: type: string allOf: – #/definitions/databaseStatus description: O status da base de dados lastStatusVerification: type: string format: date-time description: Data da última verificação do status processInProgress: type: boolean description: Se o processo de atualização ou criação está em andamento processRequestDate: type: string format: date-time description: Data de início do processo de atualização se houver cloudDatabase: type: string description: Banco de dados na nuvem para onde está sendo feita a replicação dos dados replicationInstance: type: string description: Instância utilizada para replicar os dados lastSuccessfulRefresh: type: string format: date-time description: Data da última atualização bem sucedida da base de dados tableInfo: description: Retorna o nome da tabela com o esquema e uma lista com o nome das colunas (usado no autocomplete de SQL) type: object required: – name – columns properties: name: type: string description: Esquema mais nome da tabela columns: type: array items: type: string minimum: 1 description: Lista de nomes das colunas sourceDatabaseMetadata: description: Dados de conexão com um banco de dados type: object required: – url – type properties: url: type: string description: URL de conexão secret: true schema: type: string description: Nome do schema username: type: string description: Usuário de conexão secret: true password: type: string description: Senha secret: true type: type: string description: Tipo de banco de dados 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