2.0info: 16.3.1 Visões Dinâmicas description: Service that manages and generates dynamic views x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: dynamicviews 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: /dynamicviews/queries/listDynamicViews: post: description: Lista as visões dinâmicas que o usuário tem permissão para executar\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – views properties: views: type: array items: type: object allOf: – #/definitions/listDynamicViewRec minimum: 1 description: Lista de visões dinâmicas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista as visões dinâmicas que o usuário tem permissão para executar\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – views properties: views: type: array items: type: object allOf: – #/definitions/listDynamicViewRec minimum: 1 description: Lista de visões dinâmicas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/listTables: post: description: Retorna as tabelas que o usuário tem permissão de leitura tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: – #/definitions/table minimum: 1 description: Tabelas que o usuário tem permissão de leitura 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as tabelas que o usuário tem permissão de leitura tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tables properties: tables: type: array items: type: object allOf: – #/definitions/table minimum: 1 description: Tabelas que o usuário tem permissão de leitura 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/getDynamicView: post: description: Obtém uma visão dinâmica\n ### Resources:\n – res:// dominio do tenant /custom/dynamicview/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – dynamicViewId properties: dynamicViewId: type: string description: Id da visão dinâmica responses: 200: description: Ok schema: type: object required: – dynamicView properties: dynamicView: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Visão dinâmica não encontrada default: description: Error response schema: #/definitions/genericError get: description: Obtém uma visão dinâmica\n ### Resources:\n – res:// dominio do tenant /custom/dynamicview/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: dynamicViewId description: Id da visão dinâmica in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dynamicView properties: dynamicView: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Visão dinâmica não encontrada default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/executeDynamicView: post: description: Executa a visão dinâmica\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica que deve ser executada maxRows: type: integer format: int64 description: Quantidade máxima de linhas a serem retornadas, por padrão são 10 default: 10 parameters: type: array items: type: object allOf: – #/definitions/filterParameter description: Parâmetros dos filtros da visão dinâmica. É necessário informar todos parâmetros da visão dinâmica, de outra forma é lançada exceção responses: 200: description: Ok schema: type: object required: – metadata – values properties: metadata: type: array items: type: object allOf: – #/definitions/queryMetadataColumn minimum: 1 description: Metadados da visão dinâmica values: type: array items: type: object allOf: – #/definitions/queryRow minimum: 1 description: Valores retornados pela consulta 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/executeDynamicView__15: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica que deve ser executada maxRows: type: integer format: int64 description: Quantidade máxima de linhas a serem retornadas, por padrão são 10 e o máximo é 1000 (pois serve apenas para um preview) maximum: 1000 default: 10 parameters: type: array items: type: object allOf: – #/definitions/filterParameter description: Parâmetros dos filtros da visão dinâmica. É necessário informar todos parâmetros da visão dinâmica, de outra forma é lançada exceção responses: 200: description: Ok schema: type: object required: – metadata – values properties: metadata: type: array items: type: object allOf: – #/definitions/queryMetadataColumn minimum: 1 description: Metadados da visão dinâmica values: type: array items: type: object allOf: – #/definitions/queryRow minimum: 1 description: Valores retornados pela consulta 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/previewDynamicView: post: description: Previews a Dynamic View tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica que deve ser executada maxRows: type: integer format: int64 description: Quantidade máxima de linhas a serem retornadas, por padrão são 10 default: 10 parameters: type: array items: type: object allOf: – #/definitions/filterParameter description: Parâmetros dos filtros da visão dinâmica. É necessário informar todos parâmetros da visão dinâmica, de outra forma é lançada exceção responses: 200: description: Ok schema: type: object required: – pdf properties: pdf: type: string format: byte description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/getUsageLimits: post: description: Retorna a lista de limites de uso definida tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – usageLimit – queryTimeOut properties: usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso queryTimeOut: type: integer format: int64 description: Query timeout 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de limites de uso definida tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – usageLimit – queryTimeOut properties: usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso queryTimeOut: type: integer format: int64 description: Query timeout 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /dynamicviews/queries/getRunningDynamicViews: post: description: Retorna todas as execuções dinâmicas em andamento, com informações sobre o progresso, usuário, etc. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Valor a ser pesquisado offset: type: integer format: int64 description: Index de início da busca default: 0 limit: type: integer format: int64 description: Quantidade de registro que deve ser retornado default: 10 orderByDesc: type: boolean description: Define o tipo de ordenação default: false responses: 200: description: Ok schema: type: object required: – dynamicViews – listInformation properties: dynamicViews: type: array items: type: object allOf: – #/definitions/generationStatus minimum: 1 description: Status de execução das visões dinâmicas listInformation: type: object allOf: – #/definitions/listInformation description: Informa o total de páginas de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as execuções dinâmicas em andamento, com informações sobre o progresso, usuário, etc. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Valor a ser pesquisado in: query type: string – name: offset description: Index de início da busca in: query type: integer format: int64 – name: limit description: Quantidade de registro que deve ser retornado in: query type: integer format: int64 – name: orderByDesc description: Define o tipo de ordenação in: query type: boolean responses: 200: description: Ok schema: type: object required: – dynamicViews – listInformation properties: dynamicViews: type: array items: type: object allOf: – #/definitions/generationStatus minimum: 1 description: Status de execução das visões dinâmicas listInformation: type: object allOf: – #/definitions/listInformation description: Informa o total de páginas de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dynamicviews/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 /dynamicviews/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 /dynamicviews/actions/insertDynamicView: post: description: Inserts a new Dynamic VIew tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: The view to be inserted responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 32 description: The ID of the new view 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dynamicviews/actions/updateDynamicView: post: description: Updated a dynamicView tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: The view to be updated responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dynamicviews/actions/saveDynamicView: post: description: Inserir ou atualizar uma visão dinâmica\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – view properties: view: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica que serão criada responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 32 description: ID da visão dinâmica criada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informado ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dynamicviews/actions/deleteDynamicView: post: description: Excluir uma visão dinâmica\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 32 description: ID da visão dinâmica que será excluída responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando se a operação foi realizada com sucesso 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informado ou campo informado incorretamente 403: description: Permissão negada 404: description: Visão dinâmica não encontrada default: description: Error response schema: #/definitions/genericError /dynamicviews/actions/generateDynamicViewReport: post: description: Gera o relatório definido pela visão dinâmica\n ### Resources:\n – res:// Dominio do tenant /custom/dynamicview/ identificador único \n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – format properties: id: type: string description: Id da visão dinâmica que deve ser executada, caso o usuário queira executar uma visão dinâmica persistida na base de dados view: type: object allOf: – #/definitions/dynamicViewRec description: Visão dinâmica do relatório a ser gerado format: type: string allOf: – #/definitions/format description: Formato de saída do relatório destination: type: array items: type: object allOf: – #/definitions/destinationInfo description: Destino onde o relatório gerado estará disponível parameters: type: array items: type: object allOf: – #/definitions/filterParameter description: Parâmetros dos filtros da visão dinâmica. É necessário informar todos parâmetros da visão dinâmica, de outra forma é lançada exceção limit: type: integer format: int64 description: Limite para geração do relatório. Utilizado para o preview timeToLive: type: integer format: int64 description: Quanto tempo o relatório ficará disponível depois de gerado, se não informado o valor padrão será 7200 minutos (5 dias) default: 7200 notSanitizeColumnName: type: boolean description: Não aplicar sanitização no nome das colunas default: false responses: 200: description: Ok schema: type: object required: – reportTicket properties: reportTicket: type: string description: ID de identificação do relatório gerado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 402: description: Pagamento requerido 403: description: Permissão negada 404: description: Visão dinâmica não encontrada default: description: Error response schema: #/definitions/genericError /dynamicviews/actions/cancelGeneration: post: description: Cancela a execução das visões dinâmicas em andamento.\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: Id das visões dinâmicas que devem ser canceladas responses: 200: description: Ok schema: type: object properties: status: type: string description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informados incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /dynamicviews/signals/addDynamicViewMenuItem: post: description: Adiciona um item de menu para uma visão dinâmica\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dynamicViewId – menuItemId – label – url – menuType properties: dynamicViewId: type: string description: ID da visão dinâmica menuItemId: type: string description: ID do item de menu que deve ser associado a visão dinâmica label: type: string description: Rótulo do menu da visão dinâmica url: type: string description: Url para execução do relatório menuType: type: string allOf: – #/definitions/menuType description: Tipo do menu que deve ser criado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dynamicviews/signals/removeDynamicViewMenuItem: post: description: Remove um item de menu da visão dinâmica\n ### Resources:\n – res://senior.com.br/report/dynamicview\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dynamicViewId – dynamicViewMenuItemId properties: dynamicViewId: type: string description: Id da visão dinâmica dynamicViewMenuItemId: type: string description: Id do menu da visão dinâmica responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: format: description: Formatos em que um relatório pode ser gerado type: string enum: – Pdf – Csv – Html – Xls – Xlsx – Xml – Odt – Rtf destination: description: type: string enum: – EmailWithContent – EmailWithUrl – Notification filterType: description: Tipo de um filtro da visão dinâmica type: string enum: – LITERAL – PARAMETER joinOperation: description: type: string enum: – EQUALS – NOT_EQUALS viewKind: description: type: string enum: – Generated – Manual sortDirection: description: type: string enum: – Asc – Desc columnType: description: type: string enum: – StringType – IntegerType – TimeType – DatetimeType – BooleanType – DateType – InvalidType – DecimalType – LongType filterOperator: description: type: string enum: – EQUAL – NOT_EQUAL – GREATER_THAN – GREATER_THAN_OR_EQUAL – LESS_THAN – LESS_THAN_OR_EQUAL – EMPTY – NOT_EMPTY – CONTAINS – DOES_NOT_CONTAIN – STARTS_WITH – ENDS_WITH – IN – BETWEEN logicalOperator: description: Operadores lógicos para agregação de filtros (condições) SQL type: string enum: – AND – OR functionType: description: type: string enum: – AVG – COUNT – MAX – MIN – SUM – COUNT_DISTINCT menuType: description: Tipo de menu à qual a visão dinâmica está associada type: string enum: – DEFAULT – ACTION 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 table: description: Dados de uma tabela type: object required: – id – schema – name – displayName – schemaDisplayName properties: id: type: string description: Identificador único da tabela schema: type: string description: Esquema que a tabela pertence name: type: string description: Nome da tabela displayName: type: string description: Nome de exibição da tabela schemaDisplayName: type: string description: Nome de exibição do schema destinationInfo: description: type: object required: – type properties: type: type: string allOf: – #/definitions/destination description: emailConfig: type: object allOf: – #/definitions/emailConfig description: notificationConfig: type: object allOf: – #/definitions/notificationConfig description: emailConfig: description: type: object required: – to – subject – message properties: from: type: object allOf: – #/definitions/emailContact description: to: type: array items: type: object allOf: – #/definitions/emailContact minimum: 1 description: cc: type: array items: type: object allOf: – #/definitions/emailContact description: bcc: type: array items: type: object allOf: – #/definitions/emailContact description: subject: type: string description: message: type: string description: notificationConfig: description: type: object required: – group properties: group: type: string description: Nome do grupo que receberá notificação emailContact: description: type: object required: – email – name properties: email: type: string description: name: type: string description: dynamicViewMenu: description: Id e tipo do menu à qual uma visão dinâmica está associada type: object required: – menuId – label – menuType properties: menuId: type: string description: Id do menu label: type: string description: Rótulo do menu menuType: type: string allOf: – #/definitions/menuType description: Tipo do menu dynamicViewRec: description: Representa uma visão dinâmica type: object required: – name – kind properties: id: type: string maxLength: 32 description: Id da visão dinâmica name: type: string maxLength: 256 description: Nome da visão dinâmica description: type: string maxLength: 1024 description: Descrição da visão dinâmica tags: type: array items: type: string description: Tags da visão dinâmica uri: type: string description: Uri de recurso desta visualização (somente leitura) baseUrl: type: string description: Base Url para execusão do relatório menuItems: type: array items: type: object allOf: – #/definitions/dynamicViewMenu description: Items de menu associado a visão dinâmica table: type: string maxLength: 128 description: DB Nome da tabela usado para acesso por esta visão dinâmica schema: type: string maxLength: 100 description: Schema onde a tabela está localizada tables: type: array items: type: object allOf: – #/definitions/tableRec description: Tabelas da visão dinâmica fields: type: array items: type: string description: Lista de campos exibidos por esta visão dinâmica order: type: array items: type: object allOf: – #/definitions/order description: Ordem dos campos exibidos por esta visão dinâmmica groups: type: array items: type: string description: Grupos usados nesta visão dinâmica functions: type: array items: type: object allOf: – #/definitions/function description: Funçõe usadas na visão dinâmica viewSynchronized: type: boolean description: Indica se esta visualização está sincronizada com os metadados de banco de dados atuais kind: type: string allOf: – #/definitions/viewKind description: Tipo de visualização: gerada ou manual sql: type: string description: Comando SQL desta visão dinâmica – usado apenas com tipo manual filter: type: object allOf: – #/definitions/expression description: Filtro da visão dinâmica seguindo o modelo de uma árvore binária joins: type: array items: type: object allOf: – #/definitions/joinExpression description: overrideUserTimezone: type: boolean description: Sobrescrever o timezone padrão default: false timezoneOffset: type: integer format: int64 description: Timezone que será sobrescrito pelo padrão, se não informado será utilizado UTC-0 default: 0 timeShowsSeconds: type: boolean description: Informa se colunas do tipo time deverão mostrar os segundos default: false formatDecimalColumns: type: boolean description: Informa se colunas com valores decimais deverão ser formatadas se baseando no locale default: false listDynamicViewRec: description: Representação da visão dinâmica type: object required: – id – name – description properties: id: type: string maxLength: 32 description: Id da visão dinãmica name: type: string maxLength: 256 description: Nome da visão dinâmica description: type: string maxLength: 1024 description: Descrição da visão dinâmica tags: type: array items: type: string description: Tags da visão dinâmica joinExpression: description: type: object required: – source – target – operation properties: source: type: string description: target: type: string description: operation: type: string allOf: – #/definitions/joinOperation description: tableRec: description: type: object required: – schema – name properties: schema: type: string description: name: type: string description: function: description: Representa a função usada pela visão dinâmica type: object required: – functionType – columnName properties: functionType: type: string allOf: – #/definitions/functionType description: Tipo da função columnName: type: string maxLength: 128 description: Nome do campo usado pela função description: type: string description: Descrição da função, usado como alias. order: description: Representa a ordem usada pelas visões dinâmicas type: object required: – name – direction properties: name: type: string maxLength: 128 description: Nome do campo direction: type: string allOf: – #/definitions/sortDirection description: Direção de classificação do campo queryMetadataColumn: description: Representa os metadados de uma coluna de consulta type: object required: – sequence – name – displayName – type – isPrimaryKey – isNullable – sqlOrder – isSortable – isSearchable – isAggregatable – isCustom properties: sequence: type: integer format: int64 description: Ordem desta coluna nos dados do resultado name: type: string description: Nome da coluna displayName: type: string description: Nome de exibição desta coluna – i18n type: type: string allOf: – #/definitions/columnType description: Tipo da coluna isPrimaryKey: type: boolean description: Indica se esta coluna faz parte da chave primária da tabela isNullable: type: boolean description: Indica se esta coluna é anulável sqlOrder: type: integer format: int64 description: Ordem desta coluna na consulta de resultado isSortable: type: boolean description: Se esta coluna pode ser classificada ou não isSearchable: type: boolean description: Se esta coluna pode ser usada em filtros ou não isAggregatable: type: boolean description: Se esta coluna pode ser usada em agregações ou não isCustom: type: boolean description: Se esta coluna é um campo personalizado ou não filterParameter: description: Valor do parâmetro de um filtro da visão dinâmica type: object required: – name properties: name: type: string maxLength: 256 description: Nome do parâmetro (Valor informado no campo value da UnaryExpression) value: type: string maxLength: 256 description: Valor a ser utilizado no filtro da visão dinâmica values: type: array items: type: string description: Valores a serem utilizados no filtro 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 queryRow: description: Representa uma linha de consulta type: object required: – row properties: row: type: array items: type: object allOf: – #/definitions/queryData minimum: 1 description: As colunas desta linha queryData: description: Representa um valor de coluna type: object required: – name – value properties: name: type: string description: Nome da coluna value: type: string description: Valor da coluna expression: description: Expressão para montar o filtro de uma visão dinâmica 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 da visão dinâmica allOf: – #/definitions/expression – type: object required: – column – operator properties: column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro type: type: string allOf: – #/definitions/filterType description: Tipo do filtro. caso não informado é considerado o valor LITERAL operator: type: string allOf: – #/definitions/filterOperator description: Tipo do filtro a ser aplicado value: type: string maxLength: 256 description: Valor a ser utilizado no filtro values: type: array items: type: string description: Valores a serem utilizados no filtro 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 binaryExpression: description: Expressão que realiza a combinação de dois filtros da visão dinâmica 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 usageLimit: description: Representa um limite de uso cadastrado type: object required: – label – limit – usage – freeTier properties: label: type: string description: Descrição da propriedade cadastrada como limite limit: type: number format: double description: Quantidade máxima que pode ser atingida para o recurso usage: type: number format: double description: Quantidade utilizada para o recurso freeTier: type: boolean description: Permite continuar gerando relatórios após limite máximo excedido generationStatus: description: Representa o status de execução de uma visão dinâmica type: object required: – ticketId – dynamicView – user – startTime – stage properties: ticketId: type: string description: Ticket da execução dynamicView: type: string description: Nome da visão dinâmica user: type: string description: Username que executor a visão dinâmica startTime: type: string format: date-time description: Data e hora de inicio stage: type: string description: Etapa da execução 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 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