Mais pesquisados:Customização, Tutorial, Documentação

Gerenciamento de datasets (dataset)

673 views 0 01/07/2019 Atualizado em 07/07/2025 integrador

2.0info: 3.6.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 timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 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 timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 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 – name: timezone_override description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC in: query type: boolean – name: timezone_offset description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC in: query type: integer format: int64 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\nos atributos retornados na chamada de registro datasetAuthId: type: string description: Informar o id do dataset auth para ser executado na vinculação timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 shared: type: boolean description: Se o preview deverá olhar para a base shared default: false filtersDefinition: type: array items: type: object allOf: – #/definitions/datasetFilterApiDefinition description: Filtros possíveis para aplicar no momento de executar o datasetAPI (caso tenha filtro com valor default) 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 showListInformation: type: boolean description: Informar se deseja que seja exibido o total de páginas e de registros do dataset default: true 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 /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: API DEPRECIADA: Use getLimits instead | DATA: 2020-03-30 | Retorna o tempo máximo de execução de um dataset tags: – Queries deprecated : true 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: API DEPRECIADA: Use getLimits instead | DATA: 2020-03-30 | Retorna o tempo máximo de execução de um dataset tags: – Queries deprecated : true 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/listDatasetAuths: post: description: Listar todos os Dataset Auths, pode filtrar uma lista de ids ou pesquisar genericamente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: authIds: type: array items: type: string description: Lista de Ids que se deseja pesquisar searchValue: type: string description: Pesquisar pelo Nome ou dataset uri 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: – result – listInformation properties: result: type: array items: type: object allOf: – #/definitions/datasetAuth minimum: 1 description: Lista de Resultados 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/listFactoryDatasetAuths: post: description: Listar todos os Dataset Auths, pode filtrar uma lista de ids ou pesquisar genericamente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: authIds: type: array items: type: string description: Lista de Ids que se deseja pesquisar searchValue: type: string description: Pesquisar pelo Nome ou dataset uri 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: – result – listInformation properties: result: type: array items: type: object allOf: – #/definitions/datasetAuth minimum: 1 description: Lista de Resultados 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/getDatasetAuth: post: description: Pegar um Dataset Auth pelo seu Id ou o Dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: authId: type: string description: Informar o Id do Dataset Auth datasetUri: type: string description: Informar o URI do Dataset responses: 200: description: Ok schema: type: object properties: auth: type: object allOf: – #/definitions/datasetAuth description: Retorna o Dataset Auth se encontrado bind: type: array items: type: object allOf: – #/definitions/datasetAuthBind description: Retorna o bind se existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pegar um Dataset Auth pelo seu Id ou o Dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: authId description: Informar o Id do Dataset Auth in: query type: string – name: datasetUri description: Informar o URI do Dataset in: query type: string responses: 200: description: Ok schema: type: object properties: auth: type: object allOf: – #/definitions/datasetAuth description: Retorna o Dataset Auth se encontrado bind: type: array items: type: object allOf: – #/definitions/datasetAuthBind description: Retorna o bind se existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/getFactoryDatasetAuth: post: description: Pegar um Dataset Auth pelo seu Id ou o Dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: authId: type: string description: Informar o Id do Dataset Auth datasetUri: type: string description: Informar o URI do Dataset responses: 200: description: Ok schema: type: object properties: auth: type: object allOf: – #/definitions/datasetAuth description: Retorna o Dataset Auth se encontrado bind: type: array items: type: object allOf: – #/definitions/datasetAuthBind description: Retorna o bind se existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pegar um Dataset Auth pelo seu Id ou o Dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: authId description: Informar o Id do Dataset Auth in: query type: string – name: datasetUri description: Informar o URI do Dataset in: query type: string responses: 200: description: Ok schema: type: object properties: auth: type: object allOf: – #/definitions/datasetAuth description: Retorna o Dataset Auth se encontrado bind: type: array items: type: object allOf: – #/definitions/datasetAuthBind description: Retorna o bind se existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/restrictedTableCheck: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type properties: type: type: string allOf: – #/definitions/datasetTypeDefinition description: Tipo de dataset id: type: string description: Identificador do dataset tables: type: array items: type: object allOf: – #/definitions/tableSchemaDefinition description: Tabelas do dataset sql: type: string description: Query do dataset rule: type: string description: Definição do tipo de restrição responses: 200: description: Ok schema: type: object required: – tablesRestricted properties: tablesRestricted: type: array items: type: object allOf: – #/definitions/restrictedTable minimum: 1 description: 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: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 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) timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 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 timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 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\nos atributos retornados na chamada de registro datasetAuthId: type: string description: Informar o id do dataset auth para ser executado na vinculação timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 filtersDefinition: type: array items: type: object allOf: – #/definitions/datasetFilterApiDefinition description: Filtros possíveis para aplicar no momento de executar o datasetAPI 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/saveFactoryDatasetApi: post: description: Cria ou edita um dataset para chamada de API de fábrica 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/datasetApiRegistry description: Informações base para o cadastro do Dataset API 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/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/genericError /dataset/actions/testDatasetAuth: post: description: Testar a conexão do Dataset Auth tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – auth properties: auth: type: object allOf: – #/definitions/datasetAuth description: Informar o objeto Auth responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultando do teste da conexão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveDatasetAuth: post: description: Salvar / Alterar um Dataset Auth no Tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – auth properties: auth: type: object allOf: – #/definitions/datasetAuth description: Informar o objeto Auth responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Retorna o Id do Auth 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/saveFactoryDatasetAuth: post: description: Salvar / Alterar um Dataset Auth no Shared tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – auth properties: auth: type: object allOf: – #/definitions/datasetAuth description: Informar o objeto Auth responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Retorna o Id do Auth 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/removeDatasetAuth: post: description: Excluir um Dataset Auth existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – authId properties: authId: type: string description: Informar o Id do Datset Auth responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: True: Sucesso, False: Não encontrou! (Irá excluir os Binds tambem) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/removeFactoryDatasetAuth: post: description: Excluir um Dataset Auth de Fabrica existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – authId properties: authId: type: string description: Informar o Id do Datset Auth responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: True: Sucesso, False: Não encontrou! (Irá excluir os Binds tambem) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/bindDatasetAuth: post: description: Vincular/Desvincular o Dataset ao Auth tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – bind properties: bind: type: object allOf: – #/definitions/datasetAuthBind description: Informar o Dataset Auth Set responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dataset/actions/bindFactoryDatasetAuth: post: description: Vincular/Desvincular o Dataset ao Auth de Fábrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – bind properties: bind: type: object allOf: – #/definitions/datasetAuthBind description: Informar o Dataset Auth Set responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: datasetSource: type: string enum: – TEIID – REDSHIFT – API description: Fonte de dados do dataset: * `TEIID` – Os dados do dataset são provenientes do Teiid * `REDSHIFT` – Os dados do dataset são provenientes do Redshift * `API` – Os dados do dataset são provenientes de uma API (HTTP/HTTPS) joinType: type: string enum: – INNER_JOIN – LEFT_OUTER_JOIN – RIGHT_OUTER_JOIN – FULL_OUTER_JOIN – CROSS_JOIN description: Tipo do join: * `INNER_JOIN` – Obrigatoriamente estar contido em ambas tabelas * `LEFT_OUTER_JOIN` – Obrigatoriamente estar contido na tabela de origem * `RIGHT_OUTER_JOIN` – Obrigatoriamente estar contido na tabela de destino * `FULL_OUTER_JOIN` – O que estiver contido em uma ou outra tabela * `CROSS_JOIN` – A multiplicação entre o que tiver na primeira e na segunda tabela relationalOperator: 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 description: Operador relacional: * `EQUAL` – Igual = * `NOT_EQUAL` – Não é igual * `GREATER_THAN` – Maior que * `GREATER_THAN_OR_EQUAL` – Maior ou igual = * `LESS_THAN` – Menor que * `LESS_THAN_OR_EQUAL` – Menor ou igual = * `EMPTY` – Vazio is null * `NOT_EMPTY` – Não é vazio is not null * `CONTAINS` – Contém like % text % * `DOES_NOT_CONTAINS` – Não contém not like % text % * `STARTS_WITH` – Inicia com like text % * `ENDS_WITH` – Termina com like % text * `IN` – Está entre uma coleção de valores * `NOT_IN` – Não se encontra em uma coleção de valores * `BETWEEN` – Está entre dois valores de forma inclusiva logicalOperator: type: string enum: – AND – OR description: Operadores lógicos para agregação de filtros (condições) SQL: * `AND` – Operador lógico E * `OR` – Operador lógico OU functionType: type: string enum: – AVG – COUNT – MAX – MIN – SUM – COUNT_DISTINCT description: Tipo da função a ser aplicada na projeção: * `AVG` – Média * `COUNT` – Contar * `MAX` – Máximo * `MIN` – Mínimo * `SUM` – Soma * `COUNT_DISTINCT` – Contar distintos orderType: type: string enum: – ASC – DESC description: Tipo da ordenação: * `ASC` – Crescente * `DESC` – Decrescente columnType: type: string enum: – STRING – INTEGER – DATE – DATETIME – TIME – BOOLEAN – DECIMAL – OBJECT – INVALID description: Tipo de dado da coluna: * `STRING` – String * `INTEGER` – Inteiro * `DATE` – Data * `DATETIME` – Data e hora * `TIME` – Hora * `BOOLEAN` – Booleano * `DECIMAL` – Decimal * `OBJECT` – Objeto * `INVALID` – Inválido datasetPrimitiveServiceType: type: string enum: – QUERIES – ACTIONS description: Define o tipo da primitiva (QUERY, ACTIONS): * `QUERIES` – Define o tipo como QUERY * `ACTIONS` – Define o tipo como ACTION apiReturnType: type: string enum: – JSON – CSV apiMethod: type: string enum: – OPTIONS – GET – POST description: Tipos de requests para API: * `OPTIONS` – Options * `GET` – Get * `POST` – Post datasetAuthType: type: string enum: – JSON description: Tipo do Dataset Auth: * `JSON` – Json datasetAuthUseType: type: string enum: – BEARER – HEADPROP – BODYPROP description: Tipos de ações para conectar um dataset a um auth: * `BEARER` – Bearer * `HEADPROP` – Headprop * `BODYPROP` – Bodyprop datasetAuthBindType: type: string enum: – BIND – UNBIND description: Tipos de ações para conectar um dataset a um auth: * `BIND` – Bind * `UNBIND` – Unbind datasetTypeDefinition: type: string enum: – DYNAMIC – SQL – API description: Definição de tipo de dataset: * `DYNAMIC` – Dinâmico * `SQL` – SQL * `API` – API datasetStatus: type: string enum: – ACTIVE – DEPRECATED – TO_BE_DEPRECATED userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim baseDatasetRegistry: description: discriminator: _discriminator type: object required: – id – name – _discriminator 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 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) _discriminator: type: string description: datasetRegistry: description: allOf: – #/definitions/baseDatasetRegistry – 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 datasetApiRegistry: description: allOf: – #/definitions/baseDatasetRegistry – type: object required: – apiReturn – url – method – projection 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 minimum: 1 description: Campos da projeção que serão retornados do resultado da chamada da API, se não informado serão todos\nos atributos retornados na chamada de registro.\nComo datasets de fábrica não são executados para retornar sua projeção, ela se torna obrigatória. datasetAuthId: type: string description: Informar o id do dataset auth para ser executado na vinculação timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 filtersDefinition: type: array items: type: object allOf: – #/definitions/datasetFilterApiDefinition description: Filtros possíveis para aplicar no momento de executar o datasetAPI 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) timezone_override: type: boolean description: Define se quando executar o dataset deve-se utilizar o timezone especificado ou UTC default: false timezone_offset: type: integer format: int64 description: Definição do timezone definido em tela, caso não seja informado nenhum, mas esta definido para usar, sempre utilizará o UTC default: 0 status: type: string allOf: – #/definitions/datasetStatus description: Situação do dataset _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 api 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\nos atributos retornados na chamada de registro filtersDefinition: type: array items: type: object allOf: – #/definitions/datasetFilterApiDefinition description: Filtros possíveis para aplicar no momento de executar o datasetAPI 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.\nPara o operador lógico BETWEEN é necessário que o campo tenha dois elementos, exemplo:\nFiltro:\n{\ncolumn : age,\noperator : BETWEEN,\nvalues : [ 10, 30]\n}\nSQL:\nage 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: – id – schema – table – column – label – type properties: id: type: string description: Id 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: datasetFilterValueApi: description: Lista Fixa com valores para os filtros do DatasetFilterDefinition allOf: – #/definitions/datasetFilterValue – type: object required: – value properties: value: type: string description: Valor 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 objectValue: type: string maxLength: 12000 description: Valores para um filtro do tipo OBJETO name: type: string description: O nome deste filtro no datasetAPI operator: type: string description: O operador deste filtro no datasetAPI 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 datasetAuth: description: Dataset Auth Model type: object required: – name – headers – body – returnPath – url properties: id: type: string description: Identificador Único type: type: string allOf: – #/definitions/datasetAuthType description: Definir o tipo useType: type: string allOf: – #/definitions/datasetAuthUseType description: Definir o tipo de uso name: type: string description: Nome do Dataset Auth headers: type: string description: Cabeçalho da Requisição body: type: string description: Corpo da Requisição returnPath: type: string description: Retorno da Requisição (Encadear as Propriedades) useProp: type: string description: Uso (Encadear as Propriedades) url: type: string description: Endereço Requisição datasetAuthBind: description: Vincular Auth / Dataset type: object required: – type – authId – datasetUri properties: id: type: string description: Id do Bind type: type: string allOf: – #/definitions/datasetAuthBindType description: Tipo de ação, Bind / UnBind. Padrão Bind authId: type: string description: Id do Authentication datasetUri: type: string description: Uri do Dataset factoryAuth: type: boolean description: Origem do Auth (Padrão Falso TENANT) no bind factory será ignorado default: false factoryDataset: type: boolean description: Origem do Dataset (Padrão Falso TENANT) no bind factory será ignorado default: false datasetFilterApiDefinition: description: Descritor de filtro possível de um dataset API type: object required: – key – name – label – dataType – operator properties: key: type: string description: A chave deste filtro no datasetAPI name: type: string description: O identificador deste filtro no datasetAPI 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 operator: type: string allOf: – #/definitions/relationalOperator description: Operador relacionado ao filtro objectValue: type: string maxLength: 12000 description: Valores para um filtro do tipo OBJETO defaultValue: type: string description: Um valor padrão para o filtro (caso existir) tableSchemaDefinition: description: Definição de uma tabela com um schema type: object required: – name – schema properties: name: type: string description: Nome da tabela schema: type: string description: Nome do schema restrictedTable: description: Definição de uma tabela restringida type: object required: – name – schema – restrictionType – restrictionDate – restricted properties: name: type: string description: Nome da tabela restringida schema: type: string description: Nome do schema da tabela restringida restrictionType: type: string description: Tipo de restrição restrictionDate: type: string format: date description: Data da restrinção restricted: type: boolean description: Informa se a tabela está restrita notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação