2.0info: 2.5.0 Gerenciamento de datasets description: Responsável pelo gerenciamento de datasets na plataforma G7. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: dataset 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: /dataset/queries/previewExecuteDataset: post: description: Pré-visualização do resultado da execução do dataset via wizard, retorna apenas os 10 primeiros registros encontrados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – table – projection properties: table: type: object allOf: – #/definitions/table description: Tabela projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Os campos que serão retornados filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros group: type: array items: type: object allOf: – #/definitions/group description: Os agrupamentos dos registros responses: 200: description: Ok schema: type: object required: – projection – rows properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/previewExecuteDatasetSql: post: description: Pré-visualização do resultado da execução do dataset via sql, retorna apenas os 10 primeiros registros encontrados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: query: type: string description: Query SQL, requerido se o datasetId não for informado datasetId: type: string description: Identificador do Dataset que seja deseja pré-visualizar responses: 200: description: Ok schema: type: object required: – projection – rows properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pré-visualização do resultado da execução do dataset via sql, retorna apenas os 10 primeiros registros encontrados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: query description: Query SQL, requerido se o datasetId não for informado in: query type: string – name: datasetId description: Identificador do Dataset que seja deseja pré-visualizar in: query type: string responses: 200: description: Ok schema: type: object required: – projection – rows properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/previewExecuteDatasetApi: post: description: Pré-visualização do resultado da execução do dataset via API, retorna apenas os 10 primeiros registros encontrados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: datasetId: type: string description: Identificador do Dataset que seja deseja pré-visualizar apiReturn: type: string allOf: – #/definitions/apiReturnType description: Tipo de retorno da API url: type: string description: URL HTTP/HTTPS de chamada para a API a ser consumida por este dataset method: type: string allOf: – #/definitions/apiMethod description: Tipo do método a ser executado para a chamada da API headers: type: array items: type: object allOf: – #/definitions/apiHeader description: Cabeçalhos que serão passados na chamada da API body: type: string description: Conteúdo do corpo que será passado na chamada da API responsePath: type: string description: Caminho para chegar ao array de objetos retornados pela API (para API do tipo JSON) csvDelimiter: type: string description: O delimitador de colunas para API do tipo CSV projection: type: array items: type: object allOf: – #/definitions/apiProjection description: Campos da projeção que serão retornados do resultado da chamada da API, se não informado serão todos\n os atributos retornados na chamada de registro responses: 200: description: Ok schema: type: object required: – projection – rows properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/listDatasets: post: description: Lista os datasets com paginação, podendo filtrar pelo nome, identificador ou descrição tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Texto a ser encontrado dentro do campo nome, identificador ou descrição 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: – datasets – listInformation properties: datasets: type: array items: type: object allOf: – #/definitions/dataset minimum: 1 description: Os datasets ordenados pelo nome 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 /dataset/queries/listFactoryDefaultDatasets: post: description: Lista os datasets padrões de fábrica com paginação, podendo filtrar pelo nome, identificador ou descrição tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Texto a ser encontrado dentro do campo nome, identificador ou descrição 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: – datasets – listInformation properties: datasets: type: array items: type: object allOf: – #/definitions/dataset minimum: 1 description: Os datasets ordenados pelo nome 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 /dataset/queries/getDataset: post: description: Busca as informações completas de um dataset com todos seus componentes tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do dataset responses: 200: description: Ok schema: type: object required: – dataset properties: dataset: type: object allOf: – #/definitions/dataset description: As informações do dataset e seus componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações completas de um dataset com todos seus componentes tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do dataset in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – dataset properties: dataset: type: object allOf: – #/definitions/dataset description: As informações do dataset e seus componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/executeDataset: post: description: Executa e retorna os dados de um dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico filters: type: array items: type: object allOf: – #/definitions/datasetExecutionFilter description: Quais os filtros a serem aplicados (somente para datasets de fábrica SQL/Redshift) responses: 200: description: Ok schema: type: object required: – projection – rows – lastRefresh – source properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset lastRefresh: type: string format: date-time description: Data de última atualização filters: type: array items: type: object allOf: – #/definitions/datasetFilterDefinitionOutput description: Filtros possíveis a serem aplicados (somente para datasets de fábrica SQL/Redshift) source: type: string allOf: – #/definitions/datasetSource description: Tipo da fonte dos dados do dataset (TEIID ou REDSHIFT) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/executeDatasetPaginated: post: description: Executa e retorna os dados de um dataset de modo paginado\n ## Resource:\n – res://senior.com.br/platform/dataset/dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico filters: type: array items: type: object allOf: – #/definitions/datasetExecutionFilter description: Quais os filtros a serem aplicados (somente para datasets de fábrica SQL/Redshift) pagination: type: object allOf: – #/definitions/datasetPagination description: Página de dados desejada, caso não informada será assumida uma página de 100 registros responses: 200: description: Ok schema: type: object required: – projection – rows – lastRefresh – source – listInformation properties: projection: type: array items: type: object allOf: – #/definitions/projectionMetadata minimum: 1 description: As colunas do resultado do dataset rows: type: array items: type: object allOf: – #/definitions/row minimum: 1 description: O resultado da consulta do dataset lastRefresh: type: string format: date-time description: Data de última atualização filters: type: array items: type: object allOf: – #/definitions/datasetFilterDefinitionOutput description: Filtros possíveis a serem aplicados (somente para datasets de fábrica SQL/Redshift) source: type: string allOf: – #/definitions/datasetSource description: Tipo da fonte dos dados do dataset (TEIID ou REDSHIFT) listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a página obtida 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Dataset não encontrado 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dataset/queries/getFunctions: post: description: Busca as funções disponíveis para os filtros tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/filterFunctionName minimum: 1 description: Funções 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as funções disponíveis para os filtros tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/filterFunctionName minimum: 1 description: Funções 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/listDatasources: post: description: Lista os datasources com paginação, podendo filtrar pelo nome, identificador ou url tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Texto a ser encontrado dentro do campo nome, identificador ou url 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: – datasources – listInformation properties: datasources: type: array items: type: object allOf: – #/definitions/datasource minimum: 1 description: Os datasets ordenados pelo nome 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 /dataset/queries/getDatasource: post: description: Busca as informações completas de um dataset com todos seus componentes tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do datasource responses: 200: description: Ok schema: type: object required: – datasource properties: datasource: type: object allOf: – #/definitions/completeDatasource description: As informações do datasource e seus componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações completas de um dataset com todos seus componentes tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do datasource in: query required: true type: string responses: 200: description: Ok schema: type: object required: – datasource properties: datasource: type: object allOf: – #/definitions/completeDatasource description: As informações do datasource e seus componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/getDatasets: post: description: Lista os datasets filtrando por ids tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: ids para filtrar responses: 200: description: Ok schema: type: object required: – datasets properties: datasets: type: array items: type: object allOf: – #/definitions/dataset minimum: 1 description: Os datasets ordenados pelo nome 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os datasets filtrando por ids tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ids description: ids para filtrar in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – datasets properties: datasets: type: array items: type: object allOf: – #/definitions/dataset minimum: 1 description: Os datasets ordenados pelo nome 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/getDatasetTags: post: description: Retorna todas as tags dos datasets existentes tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: string minimum: 1 description: As tags ordenadas por ordem alfabética 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as tags dos datasets existentes tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: string minimum: 1 description: As tags ordenadas por ordem alfabética 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/getExecutionTimeout: post: description: Retorna o tempo máximo de execução de um dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – timeout properties: timeout: type: integer format: int64 description: Tempo em segundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o tempo máximo de execução de um dataset tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – timeout properties: timeout: type: integer format: int64 description: Tempo em segundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/getLimits: post: description: Retorna os limites de execução do dataset, ex: máximo de registros tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – maxRows – timeout properties: maxRows: type: integer format: int64 description: Máximo de registros timeout: type: integer format: int64 description: Timeout em segundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os limites de execução do dataset, ex: máximo de registros tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – maxRows – timeout properties: maxRows: type: integer format: int64 description: Máximo de registros timeout: type: integer format: int64 description: Timeout em segundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/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 /dataset/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 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: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveDataset: post: description: Cria ou edita um dataset tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – table – projection properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset refreshTime: type: integer format: int64 description: Tempo de atualização do dataset em segundos minimum: 60 default: 180 table: type: object allOf: – #/definitions/table description: Tabela projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Os campos que serão retornados filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros group: type: array items: type: object allOf: – #/definitions/group description: Os agrupamentos dos registros tags: type: array items: type: string description: As tags associadas a esse dataset responses: 200: description: Ok schema: type: object required: – datasetId properties: datasetId: type: string maxLength: 255 description: Identificador do dataset salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveFactoryDataset: post: description: Cria ou edita um dataset de fabrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – dataset – tenant properties: dataset: type: object allOf: – #/definitions/datasetRegistry description: Dados do dataset a ser persistido tenant: type: string description: Nome do tenant que sera inserido ou atualizado o dataset (sem efeito se for um shared) responses: 200: description: Ok schema: type: object required: – datasetId properties: datasetId: type: string maxLength: 255 description: Identificador do dataset salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveFactoryDatasetSql: post: description: Cria ou edita um dataset de fabrica baseado em uma query SQL (redshift) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenant – id – name – query properties: tenant: type: string description: Nome do tenant que sera inserido ou atualizado o dataset (sem efeito se for um shared) id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://factory/tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset query: type: string description: Query SQL tags: type: array items: type: string description: As tags associadas a esse dataset shared: type: boolean description: Se este dataset é padrão ou privado do tenant resource: type: string description: URI do resource (obrigatório informar se for um shared) filterDefinitions: type: array items: type: object allOf: – #/definitions/datasetFilterDefinition description: Filtros possíveis à serem aplicados durante a execução do mesmo source: type: string allOf: – #/definitions/datasetSource description: Source que deverá ser registrado o dataset de fábrica (caso não informado, assume o valor padrão REDSHIFT) responses: 200: description: Ok schema: type: object required: – datasetId properties: datasetId: type: string maxLength: 255 description: Identificador do dataset salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/removeFactoryDataset: post: description: Remove um dataset de fabrica existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – tenant properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://factory/tenantDomain/identificadorUnico tenant: type: string description: Nome do tenant que sera inserido ou atualizado o dataset responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveDatasetSql: post: description: Cria ou edita um dataset via SQL tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – query properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset refreshTime: type: integer format: int64 description: Tempo de atualização do dataset em segundos minimum: 60 default: 180 query: type: string description: Query SQL tags: type: array items: type: string description: As tags associadas a esse dataset responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveDatasetApi: post: description: Cria ou edita um dataset para chamada de API tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – apiReturn – url – method properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset tags: type: array items: type: string description: As tags associadas a esse dataset apiReturn: type: string allOf: – #/definitions/apiReturnType description: Tipo de retorno da API url: type: string description: URL HTTP/HTTPS de chamada para a API a ser consumida por este dataset method: type: string allOf: – #/definitions/apiMethod description: Tipo do método a ser executado para a chamada da API headers: type: array items: type: object allOf: – #/definitions/apiHeader description: Cabeçalhos que serão passados na chamada da API body: type: string description: Conteúdo do corpo que será passado na chamada da API responsePath: type: string description: Caminho para chegar ao array de objetos retornados pela API (para API do tipo JSON) csvDelimiter: type: string description: O delimitador de colunas para API do tipo CSV projection: type: array items: type: object allOf: – #/definitions/apiProjection description: Campos da projeção que serão retornados do resultado da chamada da API, se não informado serão todos\n os atributos retornados na chamada de registro responses: 200: description: Ok schema: type: object required: – datasetId properties: datasetId: type: string maxLength: 255 description: Identificador do dataset salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/removeDataset: post: description: Remove um dataset existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveDatasource: post: description: Cria ou edita um datasource tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – driver – url properties: id: type: string description: Identificador do datasource seguindo o padrão: datasource://tenantDomain/identificadorUnico name: type: string description: Nome do datasource driver: type: string description: Driver class name url: type: string description: Url no padrão jdbc username: type: string description: Usuário do banco de dados password: type: string description: Senha do banco de dados poolSize: type: integer format: int64 description: Quantidade máxima de conexões responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/removeDatasource: post: description: Remove um datasource existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do datasource seguindo o padrão: datasource://tenantDomain/identificadorUnico responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: datasetSource: description: Fonte de dados do dataset type: string enum: – TEIID – REDSHIFT – API joinType: description: Tipo do join type: string enum: – INNER_JOIN – LEFT_OUTER_JOIN – RIGHT_OUTER_JOIN – FULL_OUTER_JOIN – CROSS_JOIN relationalOperator: description: Operador relacional type: string enum: – EQUAL – NOT_EQUAL – GREATER_THAN – GREATER_THAN_OR_EQUAL – LESS_THAN – LESS_THAN_OR_EQUAL – EMPTY – NOT_EMPTY – CONTAINS – DOES_NOT_CONTAINS – STARTS_WITH – ENDS_WITH – IN – NOT_IN – BETWEEN logicalOperator: description: Operadores lógicos para agregação de filtros (condições) SQL type: string enum: – AND – OR functionType: description: Tipo da função a ser aplicada na projeção type: string enum: – AVG – COUNT – MAX – MIN – SUM – COUNT_DISTINCT orderType: description: Tipo da ordenação type: string enum: – ASC – DESC columnType: description: Tipo de dado da coluna type: string enum: – STRING – INTEGER – DATE – DATETIME – TIME – BOOLEAN – DECIMAL – INVALID datasetPrimitiveServiceType: description: Define o tipo da primitiva (QUERY, ACTIONS) type: string enum: – QUERIES – ACTIONS apiReturnType: description: type: string enum: – JSON – CSV apiMethod: description: Tipos de requests para API type: string enum: – OPTIONS – GET – POST 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 datasetRegistry: description: type: object required: – id – name – table – projection properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico ou dataset://factory/tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset refreshTime: type: integer format: int64 description: Tempo de atualização do dataset em segundos minimum: 60 default: 180 table: type: object allOf: – #/definitions/table description: Tabela projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Os campos que serão retornados filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros group: type: array items: type: object allOf: – #/definitions/group description: Os agrupamentos dos registros tags: type: array items: type: string description: As tags associadas a esse dataset shared: type: boolean description: Se este dataset é padrão ou privado do tenant resource: type: string description: URI do resource (obrigatório informar se for um shared) dataset: description: Informações básicas de um dataset discriminator: _discriminator type: object required: – id – name – createdBy – createdDate – type – resource – source – _discriminator properties: id: type: string maxLength: 255 description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do dataset description: type: string maxLength: 255 description: Descrição do dataset refreshTime: type: integer format: int64 description: Tempo de atualização do dataset em segundos minimum: 30 default: 30 createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação type: type: string description: Tipo de dataset resource: type: string description: URI do recurso isOwner: type: boolean description: Retorna se o usuário é dono do dataset default: false tags: type: array items: type: string description: Tags que identificam o dataset source: type: string allOf: – #/definitions/datasetSource description: Fonte dos dados do dataset filterDefinition: type: array items: type: object allOf: – #/definitions/datasetFilterDefinition description: Filtros possíveis à serem aplicados durante a execução do mesmo (somente aplicável para tipos SQL de fábrica) _discriminator: type: string description: completeDataset: description: Informações completas de um dataset allOf: – #/definitions/dataset – type: object required: – table – projection properties: table: type: object allOf: – #/definitions/table description: Tabela projection: type: array items: type: object allOf: – #/definitions/projection minimum: 1 description: Os campos que serão retornados filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros group: type: array items: type: object allOf: – #/definitions/group description: Os agrupamentos dos registros completeDatasetSql: description: Informações completas de um dataset sql allOf: – #/definitions/dataset – type: object required: – query properties: query: type: string description: Query Sql completeDatasetApi: description: Informações completas de um dataset sql allOf: – #/definitions/dataset – type: object required: – apiReturn – url – method properties: apiReturn: type: string allOf: – #/definitions/apiReturnType description: Tipo de retorno da API url: type: string description: URL HTTP/HTTPS de chamada para a API a ser consumida por este dataset method: type: string allOf: – #/definitions/apiMethod description: Tipo do método a ser executado para a chamada da API headers: type: array items: type: object allOf: – #/definitions/apiHeader description: Cabeçalhos que serão passados na chamada da API body: type: string description: Conteúdo do corpo que será passado na chamada da API responsePath: type: string description: Caminho para chegar ao array de objetos retornados pela API (para API do tipo JSON) csvDelimiter: type: string description: O delimitador de colunas para API do tipo CSV projection: type: array items: type: object allOf: – #/definitions/apiProjection description: Campos da projeção que serão retornados do resultado da chamada da API, se não informado serão todos\n os atributos retornados na chamada de registro 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 datasetPagination: description: As configurações de paginação de uma listagem de executeDatasetPaginated 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: 100 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 table: description: Regisro de uma tabela type: object required: – schema – name properties: schema: type: string maxLength: 128 description: Nome do schema name: type: string maxLength: 128 description: Nome da tabela join: type: object allOf: – #/definitions/join description: Ligação com outra tabela join: description: Representa uma tabela de ligação. Não são suportadas tabelas repetidas em uma consulta type: object required: – schema – table – type properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela filter: type: object allOf: – #/definitions/expression description: Os filtros utilizados para realizar a ligação, obrigatório em todos os tipos com exceção do CROSS_JOIN type: type: string allOf: – #/definitions/joinType description: O tipo da ligação join: type: object allOf: – #/definitions/join description: Ligação com outra tabela projection: description: Projeção type: object required: – schema – table – column – label properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro label: type: string maxLength: 255 description: Rótulo a ser exibido no nome da coluna, podendo ser uma chave de internacionalização function: type: string allOf: – #/definitions/functionType description: Informa uma função pra ser aplicada na coluna order: description: Ordenação type: object required: – schema – table – column – order properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro order: type: string allOf: – #/definitions/orderType description: Ordem group: description: Agrupamento type: object required: – schema – table – column properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro expression: description: Expressão para montar um filtro seguindo o modelo de uma árvore binária. discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: unaryExpression: description: Expressão para filtrar uma coluna allOf: – #/definitions/expression – type: object required: – schema – table – column – operator properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro operator: type: string allOf: – #/definitions/relationalOperator description: Tipo do filtro a ser aplicado value: type: object allOf: – #/definitions/value description: Valor a ser utilizado no filtro binaryExpression: description: Expressão que realiza a combinação de dois filtros allOf: – #/definitions/expression – type: object required: – operator – leftExpression – rightExpression properties: operator: type: string allOf: – #/definitions/logicalOperator description: Tipo de combinação a ser realizada leftExpression: type: object allOf: – #/definitions/expression description: Filtro esquerdo rightExpression: type: object allOf: – #/definitions/expression description: Filtro direito value: description: Registro base de valor, podendo ser staticValue, primitiveValue ou columnValue. discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: staticValue: description: Representa o valor estático de um filtro allOf: – #/definitions/value – type: object required: – values properties: values: type: array items: type: string minimum: 1 description: Enviar mais de um elemento quando o filtro é do tipo IN ou BETWEEN.\n Para o operador lógico BETWEEN é necessário que o campo tenha dois elementos, exemplo:\n Filtro:\n {\n column : age,\n operator : BETWEEN,\n values : [ 10, 30]\n }\n SQL:\n age BETWEEN 10 AND 30 columnValue: description: Valor do tipo coluna existente allOf: – #/definitions/value – type: object required: – schema – table – column properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro primitiveValue: description: Valor do tipo primitiva, onde o retorno da primitiva é utilizado para comparar o valor allOf: – #/definitions/value – type: object required: – domain – service – primitive – returnType properties: domain: type: string maxLength: 255 description: Nome do domínio service: type: string maxLength: 255 description: Nome do serviço primitive: type: string maxLength: 255 description: Nome da primitiva returnType: type: string maxLength: 50 description: Tipo do retorno da primitiva 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 projectionMetadata: description: Projeção com o tipo de coluna type: object required: – schema – table – column – label – type properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro label: type: string maxLength: 255 description: Rótulo a ser exibido no nome da coluna, podendo ser uma chave de internacionalização type: type: string allOf: – #/definitions/columnType description: Tipo da coluna function: type: string allOf: – #/definitions/functionType description: Informa uma função aplicada na coluna filterFunctionName: description: Objeto que representa os tipos de funções disponíveis type: object required: – id – name properties: id: type: string description: Identificador da função name: type: string description: Nome da função datasource: description: Informações basicas de um datasource type: object required: – id – name – url – createdBy – createdDate properties: id: type: string description: Identificador do datasource seguindo o padrão: datasource://tenantDomain/identificadorUnico name: type: string description: Nome do datasource url: type: string description: URL do datasource createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação completeDatasource: description: Informações completas de um datasource type: object required: – id – name – driver – url – createdBy – createdDate properties: id: type: string description: Identificador do datasource seguindo o padrão: datasource://tenantDomain/identificadorUnico name: type: string description: Nome do datasource driver: type: string description: Driver class name url: type: string description: Url no padrão jdbc username: type: string description: Usuário do banco de dados password: type: string description: Senha do banco de dados poolSize: type: integer format: int64 description: Quantidade máxima de conexões createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação datasetFilterValue: description: Definição de valores padrão para os filtros do DatasetFilterDefinition discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: datasetFilterItem: description: Item de Lista Fixa para os valores dos filtros do DatasetFilterDefinition type: object required: – value – description properties: value: type: string description: Valor description: type: string description: Descrição datasetFilterList: description: Lista Fixa com valores para os filtros do DatasetFilterDefinition allOf: – #/definitions/datasetFilterValue – type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/datasetFilterItem minimum: 1 description: datasetFilterPrimitive: description: Configuração da primitiva que irá retornar os valores que poderam ser utilizados nos filtros adicionais allOf: – #/definitions/datasetFilterValue – type: object required: – value – description – domain – service – type – name – search – records properties: value: type: string description: Valor description: type: string description: Descrição domain: type: string description: Informar o nome do domínio service: type: string description: Informar o nome do serviço type: type: string allOf: – #/definitions/datasetPrimitiveServiceType description: Informar o tipo da primitiva, queries ou actions name: type: string description: Informar o nome da primitiva search: type: string description: Informe o campo que será utilizado ao realizar a pesquisa records: type: string description: Atributo que contem os dados no retorno da primitiva datasetFilterDefinition: description: Descritor de filtro possível de um dataset de fábrica SQL (Redshift) type: object required: – key – label – dataType – expression properties: key: type: string description: O identificador deste filtro no dataset label: type: string description: Rótulo de apresentação (chave de internacionalização) dataType: type: string allOf: – #/definitions/columnType description: Tipo do dado deste filtro expression: type: string description: A expressão que compõe este filtro filterValue: type: object allOf: – #/definitions/datasetFilterValue description: Valor Padrão datasetFilterDefinitionOutput: description: Descritor de filtro possível de um dataset de fábrica SQL (Redshift) retornado na execução do dataset type: object required: – key – label – dataType properties: key: type: string description: O identificador deste filtro no dataset label: type: string description: Rótulo de apresentação (chave de internacionalização) dataType: type: string allOf: – #/definitions/columnType description: Tipo do dado deste filtro filterValue: type: object allOf: – #/definitions/datasetFilterValue description: Valor Padrão datasetExecutionFilter: description: Descritor de um filtro customizado para um dataset de fábrica SQL (Redshift) type: object required: – key – relationalOperator properties: key: type: string description: O identificador do filtro logicalOperator: type: string allOf: – #/definitions/logicalOperator description: O operador lógico do filtro a ser aplicado junto ao filtro anterior relationalOperator: type: string allOf: – #/definitions/relationalOperator description: O operador relacional entre o filtro e o valor informado value: type: array items: type: string description: O valor a ser utilizado na execução da query apiHeader: description: type: object required: – name – value properties: name: type: string description: Nome do cabeçalho value: type: string description: Valor do cabeçalho apiProjection: description: type: object required: – path – label – type properties: path: type: string description: Caminho para o atributo a ser utilizado no retorno do dataset label: type: string description: Rótulo a ser exibido no nome da coluna, podendo ser uma chave de internacionalização type: type: string allOf: – #/definitions/columnType description: Tipo do dado do atributo 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