2.0info: 16.3.1 Relatórios description: Serviço que gerencia e gera relatórios x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: report 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: /report/queries/getParameters: post: description: Retorna os parâmetros do relatório através do identificador do relatório ou do identificador do arquivo do relatório\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Identificador do relatório reportFileId: type: object allOf: – #/definitions/reportFileId description: Identificador do arquivo do relatório responses: 200: description: Ok schema: type: object required: – parameters – systemDefinedParameters properties: parameters: type: array items: type: object allOf: – #/definitions/parameterDef minimum: 1 description: Os parâmetros existentes no relatório cujos valores são definidos pelo usuário systemDefinedParameters: type: array items: type: string minimum: 1 description: Os parâmetros existentes no relatório cujos valores são definidos automaticamente pelo serviço 401: description: Invalid Credentials 403: description: Permissão negada 404: description: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/queries/findReportsByDomain: post: description: Recupera todos os relatórios que pertencem a um domínio ou serviço. Se um dos argumentos for omitido, ele não\n será considerado na pesquisa.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço after: type: string description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – reports – total properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Lista de relatórios encontrados total: type: integer format: int64 description: 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Recupera todos os relatórios que pertencem a um domínio ou serviço. Se um dos argumentos for omitido, ele não\n será considerado na pesquisa.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do domínio in: query type: string – name: serviceName description: Nome do serviço in: query type: string – name: after description: in: query type: string – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – reports – total properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Lista de relatórios encontrados total: type: integer format: int64 description: 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/queries/findReportsByTag: post: description: Pesquisa todos os relatórios que possuem as tags fornecidas.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tags properties: tags: type: array items: type: string minimum: 1 description: Lista de tags para pesquisa after: type: string description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – reports – total properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Lista de relatórios encontrados total: type: integer format: int64 description: 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Pesquisa todos os relatórios que possuem as tags fornecidas.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tags description: Lista de tags para pesquisa in: query required: true type: array items: type: string minimum: 1 – name: after description: in: query type: string – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – reports – total properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Lista de relatórios encontrados total: type: integer format: int64 description: 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/queries/findReportsByName: post: description: Pesquisa todos os relatórios que possuem um nome correspondente à entrada.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do relatório after: type: string description: limit: type: integer format: int64 description: domain: type: string description: service: type: string description: operator: type: string allOf: – #/definitions/operator description: responses: 200: description: Ok schema: type: object required: – reports – total properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Lista de relatórios encontrados total: type: integer format: int64 description: 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 /report/queries/getReportUri: post: description: Retorna um URI para acessar um relatório gerado. Se o relatório foi distribuído de uma forma que não suporta esta consulta (por exemplo, e-mail), nada será retornado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – reportTicket properties: reportTicket: type: string description: ID do relatório responses: 200: description: Ok schema: type: object properties: reportUri: type: string description: URI do relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna um URI para acessar um relatório gerado. Se o relatório foi distribuído de uma forma que não suporta esta consulta (por exemplo, e-mail), nada será retornado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: reportTicket description: ID do relatório in: query required: true type: string responses: 200: description: Ok schema: type: object properties: reportUri: type: string description: URI do relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/queries/getReportStatus: post: description: Obtém o status de um relatório que está sendo gerado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – reportTicket properties: reportTicket: type: string description: ID do relatório responses: 200: description: Ok schema: type: object required: – reportStatus properties: reportStatus: type: object allOf: – #/definitions/generationStatus description: Status de geração do relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obtém o status de um relatório que está sendo gerado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: reportTicket description: ID do relatório in: query required: true type: string responses: 200: description: Ok schema: type: object required: – reportStatus properties: reportStatus: type: object allOf: – #/definitions/generationStatus description: Status de geração do relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/queries/getReportDefinitionUri: post: description: Retorna uma URI para download de um modelo de relatório\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID do relatório responses: 200: description: Ok schema: type: object required: – reportModelUri properties: reportModelUri: type: string description: URI do modelo de relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna uma URI para download de um modelo de relatório\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID do relatório in: query required: true type: string responses: 200: description: Ok schema: type: object required: – reportModelUri properties: reportModelUri: type: string description: URI do modelo de relatório 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/queries/getRunningReports: post: description: Retorna todos os relatórios que estão em execução, com informações sobre o progresso, usuário, etc.\n ### Resources:\n – res://senior.com.br/report/report\n 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 filterCancelled: type: boolean description: Filtro para incluir relatórios cancelados, se não informado valor padrão será falso default: false orderByDesc: type: boolean description: Definir a ordenação dos registros, se não informado o valor informado será falso default: false 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: – runningReports – listInformation properties: runningReports: type: array items: type: object allOf: – #/definitions/generationStatus minimum: 1 description: Lista de relatórios em execução listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o total de páginas e registros encontrados 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/queries/listReports: post: description: Obtém a lista de todos os relatórios cujo domínio, serviço, nome do arquivo, autor original, último autor, e/ou nome do relatório contenha o termo pesquisado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nos campos domínio, serviço, nome do arquivo, autor original, último autor, e/ou nome do relatório 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: – reports – listInformation properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Os elementos retornados pela listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/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 properties: usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso 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 properties: usageLimit: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Limite de uso 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 /report/queries/getSampleSchemas: post: description: Retorna a lista dos exemplos de schemas da base de dados utilizada pelos relatórios tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – sampleSchemas properties: sampleSchemas: type: array items: type: object allOf: – #/definitions/sampleSchema minimum: 1 description: Os dados dos exemplos existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista dos exemplos de schemas da base de dados utilizada pelos relatórios tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – sampleSchemas properties: sampleSchemas: type: array items: type: object allOf: – #/definitions/sampleSchema minimum: 1 description: Os dados dos exemplos existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/queries/getSampleSchemaFiles: post: description: Obtem as informações de todos os arquivos associados (schemas e amostras) a um exemplo do schema da base de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do exemplo responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/file minimum: 1 description: Os arquivos associados ao exemplo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem as informações de todos os arquivos associados (schemas e amostras) a um exemplo do schema da base de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do exemplo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/file minimum: 1 description: Os arquivos associados ao exemplo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/queries/listLookupFunctionServices: post: description: Lista todos os serviços que possui primitivas compativéis com função de pesquisa tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/serviceId description: Serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os serviços que possui primitivas compativéis com função de pesquisa tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/serviceId description: Serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/queries/listLookupFunctionPrimitives: post: description: Lista de primitivas compativéis com função de pesquisa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/serviceId description: Serviços responses: 200: description: Ok schema: type: object properties: primitives: type: array items: type: object allOf: – #/definitions/primitiveId description: Primitivas 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 /report/queries/listSharedReports: post: description: Obtém a lista de todos os relatórios shared cujo domínio, serviço, nome do arquivo, autor original, último autor, e/ou nome do relatório contenha o termo pesquisado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nos campos domínio, serviço, nome do arquivo, autor original, último autor, e/ou nome do relatório 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: – reports – listInformation properties: reports: type: array items: type: object allOf: – #/definitions/report minimum: 1 description: Os elementos retornados pela listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/queries/getSharedReport: post: description: Obtém os dados de um relatório da base shared, com base no seu ID tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – reportId properties: reportId: type: string description: ID do relatório na base shared responses: 200: description: Ok schema: type: object required: – sharedReport properties: sharedReport: type: object allOf: – #/definitions/report description: Dados do relatório na base shared 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Obtém os dados de um relatório da base shared, com base no seu ID tags: – Queries x-senior-visibility: PUBLIC parameters: – name: reportId description: ID do relatório na base shared in: query required: true type: string responses: 200: description: Ok schema: type: object required: – sharedReport properties: sharedReport: type: object allOf: – #/definitions/report description: Dados do relatório na base shared 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/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 /report/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 /report/actions/generateReport: post: description: Gera um relatório identificado pelo id informado.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – format properties: id: type: string description: Id do relatório que será gerado format: type: string allOf: – #/definitions/format description: Formato de saída do relatório 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 (5 dias) default: 7200 parameters: type: array items: type: object allOf: – #/definitions/parameterValue description: Valor para os parâmetros necessários destination: type: array items: type: object allOf: – #/definitions/destinationInfo description: Destino onde o relatório ficará disponível overrideUserTimezone: type: boolean description: Sobrescrever o timezone padrão. default: false timezoneOffset: type: integer format: int64 description: Timezone que será aplicado na geração do relatório, se não informado o padrão será UTC 0 default: 0 responses: 200: description: Ok schema: type: object required: – reportTicket properties: reportTicket: type: string description: ID de identificação do relatório que será gerado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretemante 402: description: Pagamento requerido 403: description: Permissão negada 404: description: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/actions/generateReportQueue: post: description: Gera um relatório identificado pelo id informado (porém, com uma prioridade baixa de execução).\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – format properties: id: type: string description: Id do relatório que será gerado format: type: string allOf: – #/definitions/format description: Formato de saída do relatório 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 (5 dias) default: 7200 parameters: type: array items: type: object allOf: – #/definitions/parameterValue description: Valor para os parâmetros necessários destination: type: array items: type: object allOf: – #/definitions/destinationInfo description: Destino onde o relatório ficará disponível overrideUserTimezone: type: boolean description: Sobrescrever o timezone padrão. default: false timezoneOffset: type: integer format: int64 description: Timezone que será aplicado na geração do relatório, se não informado o padrão será UTC 0 default: 0 responses: 200: description: Ok schema: type: object required: – reportTicket properties: reportTicket: type: string description: ID de identificação do relatório que será gerado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretemante 402: description: Pagamento requerido 403: description: Permissão negada 404: description: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/actions/requestUploadLocation: post: description: Solicita um URI para onde uma definição de relatório será enviada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objectId – fileName properties: objectId: type: string description: ID do objeto fileName: type: string description: Nome do arquivo shared: type: boolean description: Valida se é para buscar um dir no bucket shared responses: 200: description: Ok schema: type: object required: – location – version properties: location: type: string description: Localização type: string description: Versão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/confirmUpload: post: description: Confirma a conclusão do upload da definição do relatório tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objectId – version – fileName properties: objectId: type: string description: ID do objeto type: string description: Versão fileName: type: string description: Nome do arquivo shared: type: boolean description: Valida se é para confirmar o arquivo no bucket shared responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/cancelGeneration: post: description: Cancelar os relatórios que estão em execução\n ### Resources:\n – res://senior.com.br/report/report\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 dos relatórios que serão cancelados responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da solicitação de cancelamento da execução dos relatórios 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 /report/actions/toggleEnabled: post: description: Habilita ou desabilita um relatório. Um relatório desabilitado não pode ser gerado\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – enabled properties: id: type: string description: ID do relatório que será habilitado/desabilitado enabled: type: boolean description: Habilitar/desabilitar responses: 200: description: Ok schema: type: object required: – previousState properties: previousState: type: boolean description: Estado anterior 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/actions/toggleEnabledAll: post: description: Altera o estado de todos os relatórios.\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – enabled properties: enabled: type: boolean description: Habilitar/Desabilitar responses: 200: description: Ok schema: type: object required: – updatedReports properties: updatedReports: type: integer format: int64 description: Número de relatórios que foram atualizados 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 /report/actions/deleteReportFile: post: description: Deleta um arquivo de relatório tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – reportFileId properties: reportFileId: type: object allOf: – #/definitions/reportFileId description: Identificador do arquivo que deve ser deletado responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a execução correu com sucesso 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Arquivo de relatório não encontrado 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /report/actions/removeSampleSchema: post: description: Remove um exemplo da lista de exemplos de Schemas da base de dados utilizada pelos relatórios tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do exemplo responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se a remoção foi realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/createSampleSchema: post: description: Cria um exemplo de schema da base de dados utilizada pelos relatórios.\n É gerado um script com comandos DDL que criam tabelas equivalentes às tabelas e visões da base de relatórios. Também é gerado um script com os inserts\n para gerar uma amostra da base de dados. Os scripts são compatíveis com o banco PostgreSQL.\n A geração dos scripts ocorre de forma assíncrona, o usuário que chamou a primitiva receberá uma notificação informando o sucesso ou erro no final da geração.\n O script ficará salvo em um arquivo no BlobService e poderá ser acessado por meio da primitiva getSampleSchemaFiles. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – maxRowsForSnapshot properties: name: type: string description: Nome do schema de exemplo maxRowsForSnapshot: type: integer format: int64 description: Número máximo de linhas de cada tabela que serão consideradas na amostra de dados da base. O número mínimo é 0 e o máximo é 1000 minimum: 0 maximum: 1000 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/getAddSnapshotInformation: post: description: Obtem as informações necessárias para realizar a inclusão de uma nova amostra de dados em um exemplo da base de dados tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url – fileId – version properties: url: type: string description: A URL para a qual deve realizar o upload do arquivo da amostra fileId: type: string description: Identificador do arquivo da amostra type: string description: A versão do arquivo para upload 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/addSampleSnapshot: post: description: Realiza a inclusão de uma nova amostra de dados em um exemplo da base de dados\n O arquivo da amostra dever ser armazenado na URL fornecida pela primitiva getAddSnapshotInformation tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idSchema – name – fileId – version properties: idSchema: type: string description: Identificador do schema da base de dados onde essa amostra será adicionada name: type: string description: Nome da amostra de dados fileId: type: string description: Identificador do arquivo da amostra. Obtido da primitiva getAddSnapshotInformation fileName: type: string description: Nome do arquivo da amostra. O nome padrão é snapshot.sql default: snapshot.sql type: string description: A versão do arquivo da amostra. Obtido da primitiva getAddSnapshotInformation responses: 200: description: Ok schema: type: object required: – sampleSnapshot – file properties: sampleSnapshot: type: object allOf: – #/definitions/sampleSnapshot description: O registro criado da amostra da base de dados file: type: object allOf: – #/definitions/file description: As informações do arquivo associado a amostra da base de dados adicionado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/removeSampleSnapshot: post: description: Remove uma amostra de dados de um exepmlo da base de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – idSchema properties: id: type: string description: Identificador da amostra da base de dados idSchema: type: string description: Identificador do schema da base de dados onde a amostra está associada responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se a remoção foi realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/saveFactoryReport: post: description: Cria/edita um relatório de fabrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – report properties: report: type: object allOf: – #/definitions/reportRegistry description: Definição do relatório responses: 200: description: Ok schema: type: object required: – savedReport properties: savedReport: type: object allOf: – #/definitions/report description: Dados do relatório salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/removeFactoryReport: post: description: Deleta um relatório de fábrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – reportId – tenant – shared properties: reportId: type: string maxLength: 255 description: Id do relatório a remover tenant: type: string description: Tenant que está cadastrado o relatório shared: type: boolean description: Se este relatório é padrão ou privado do tenant responses: 200: description: Ok schema: type: object required: – reportId properties: reportId: type: string maxLength: 255 description: Id do relatório removido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/toggleEnabledSharedReport: post: description: Habilita ou desabilita um relatório da base shared. Um relatório desabilitado não pode ser gerado\n ### Resources:\n – res://senior.com.br/report/report_shared\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – enabled properties: id: type: string description: ID do relatório que será habilitado/desabilitado enabled: type: boolean description: Habilitar/desabilitar responses: 200: description: Ok schema: type: object required: – previousState properties: previousState: type: boolean description: Estado anterior 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: Relatório não encontrado default: description: Error response schema: #/definitions/genericError /report/signals/addReportMenuItem: post: description: Adiciona um item de menu para um relatório\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – reportId – menuItemId – label – url – menuType properties: reportId: type: string description: ID do relatório menuItemId: type: string description: ID do item de menu que deve ser associado ao relatório label: type: string description: Rótulo do menu do relatório 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 /report/signals/removeReportMenuItem: post: description: Remove um item de menu do relatório\n ### Resources:\n – res://senior.com.br/report/report\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – reportId – reportMenuItemId properties: reportId: type: string description: ID do relatório reportMenuItemId: type: string description: ID do menu do relatório responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /report/events/reportReady: post: description: Notifies that a request to generate a report is done. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – reportTicket – origin – type – subject – content properties: reportTicket: type: string description: Ticket that identifies which report is done origin: type: string description: Below information is defined as the contract defined by the solution platform for notifications type: type: string description: subject: type: string description: content: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /report/entities/report: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/report responses: 200: description: The created resource schema: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/report responses: 200: description: The created resource schema: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/entities/report/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/report responses: 200: description: Ok schema: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/report responses: 200: description: Ok schema: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/report 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/entities/report/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/report responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: format: description: Formatos em que um relatório pode ser gerado type: string enum: – Pdf – Csv – Html – Xls – Xlsx – Xml – Odt – Rtf stage: description: Etapa de geração do relatório type: string enum: – Starting – Compiling – Filling – Exporting – Done – Cancelled – Generated – Error destination: description: type: string enum: – EmailWithContent – EmailWithUrl – Social type: description: type: string enum: – String – Integer – Double – Boolean – Date – DateTime – Time – Object – List – ArrayList – Map menuType: description: Tipo de menu à qual o relatório está associado type: string enum: – DEFAULT – ACTION operator: description: type: string enum: – EQUALS – LIKE 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 reportFileId: description: Identificador de um arquivo de relatório type: object required: – objectId – fileName properties: objectId: type: string description: Identificador único do arquivo fileName: type: string description: Nome do arquivo sampleSchema: description: Um exemplo do schema da base de dados utilizada pelos relatórios type: object required: – id – name – fileId – createdBy – createdDate – snapshots properties: id: type: string description: Identificador do exemplo name: type: string description: Nome do exemplo fileId: type: string description: Identificador do arquivo da estrutura da base de dados createdBy: type: string description: Usuário que criou o exemplo createdDate: type: string format: date-time description: Data e hora da criação do exemplo snapshots: type: array items: type: object allOf: – #/definitions/sampleSnapshot minimum: 1 description: As amostras de dados com base nesse schema sampleSnapshot: description: Uma amostra dos dados da base de dados utilizada pelos relatórios type: object required: – id – name – fileId – fileName – generated – createdBy – createdDate properties: id: type: string description: Identificador do exemplo name: type: string description: Nome do exemplo fileId: type: string description: Identificador do arquivo da amostra de dados fileName: type: string description: Nome do arquivo da amostra de dados generated: type: boolean description: Se a amostra de dados foi gerada automaticamente createdBy: type: string description: Usuário que criou o exemplo createdDate: type: string format: date-time description: Data e hora da criação do exemplo file: description: Um arquivo armazenado pelo sistema type: object required: – id – name – url properties: id: type: string description: Identificador do arquivo name: type: string description: Nome do arquivo url: type: string description: A URL para obtenção do arquivo reportHeader: description: type: object required: – id – name properties: id: type: string description: name: type: string description: parameterValue: description: Valor para o parâmetro de entrada do relatório type: object required: – name – value properties: name: type: string description: Nome do parâmetro value: type: string format: byte description: Valor do parâmetro lookupParameter: description: Indica que um parâmetro do relatório é do tipo lookup type: object required: – name – domain – service – primitive properties: name: type: string description: Nome do parâmetro domain: type: string description: Domínio do serviço da primitiva service: type: string description: Serviço da primitiva primitive: type: string description: Primitiva que deve ser utilizada para buscar os valores do parâmetro parameterDef: description: Deinfição dos parâmetros type: object required: – name properties: name: type: string description: Nome do parâmetro description: type: string description: Descrição do parâmetro type: type: string allOf: – #/definitions/type description: Tipo do parâmetro String, Integer, etc. required: type: boolean description: Definir o parâmetro como obrigatório inputMask: type: string description: Definir a máscara para ser usado no campo de filtro generationStatus: description: Status de geração do relatório type: object required: – ticketId – report – user – startTime – stage properties: ticketId: type: string description: Id do relatório report: type: object allOf: – #/definitions/reportHeader description: Relatório user: type: string description: usuário startTime: type: string format: date-time description: Início da geração do relatório stage: type: string allOf: – #/definitions/stage description: Etapa da geração do relatório reportReadyEvent: description: type: object required: – ticketId – origin – type – subject – content properties: ticketId: type: string description: origin: type: string description: type: type: string description: subject: type: string description: content: type: string description: destinationInfo: description: Informações de destino do relatório type: object required: – type properties: type: type: string allOf: – #/definitions/destination description: emailConfig: type: object allOf: – #/definitions/emailConfig description: socialConfig: type: object allOf: – #/definitions/socialConfig 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 maxLength: 5000 description: emailContact: description: type: object required: – email properties: email: type: string description: name: type: string description: socialConfig: description: type: object required: – space – text properties: space: type: string description: text: type: string description: reportMenu: description: Id e tipo do menu à qual um relatório está associado 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 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 pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As informações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas serviceId: description: Seviço id. type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço primitiveId: description: Primitiva id. type: object required: – domainName – serviceName – name properties: domainName: type: string description: Nome do domínio. serviceName: type: string description: Nome do serviço name: type: string description: Nome da primitiva reportRegistry: description: type: object required: – shared – report properties: shared: type: boolean description: Se este relatório é padrão ou privado do tenant tenant: type: string description: Nome do tenant que sera inserido ou atualizado o relatório (sem efeito se for um shared) report: type: object allOf: – #/definitions/report description: Definição do relatório report: description: Representa as informações sobre o relatório type: object required: – name – objectId – fileName – ownerDomain – ownerService properties: id: type: string description: name: type: string description: Nome do relatório objectId: type: string description: ID usado para identificar o modelo de relatório no serviço de armazenamento fileName: type: string description: Nome usado quando o arquivo é recuperado do armazenamento ownerDomain: type: string description: Domínio que criou o relatório ownerService: type: string description: Serviço que criou o relatório resourceName: type: string description: Nome do relatório como recurso para verificação de autorização. É opcional apenas para relatórios personalizados. resourceCreated: type: boolean description: É informado pelo aplicativo quando o recurso de relatório personalizado é criado com sucesso. enabled: type: boolean description: Relatório habilitado tags: type: array items: type: string description: Tags para o relatório menuItems: type: array items: type: object allOf: – #/definitions/reportMenu description: Items de menu que o relatório está associado ttl: type: integer format: int64 description: Tempo de vida, por quanto tempo o relatório estará disponível depois de gerado. Se não informado o padrão é 7200 (5 dias) creationUser: type: string description: Nome do usuário que criou o relatório creationTime: type: string format: date-time description: Data e hora que o relatório foi criado updateUser: type: string description: Nome do ultimo usuário que atualizou o relatório updateTime: type: string format: date-time description: Data e hora da ultima atualização do relatório lookupParameters: type: array items: type: object allOf: – #/definitions/lookupParameter description: Parâmetros do relatório que são do tipo lookup baseUrl: type: string description: Base Url for execution the report factory: type: boolean description: Informação para saber se a origem do relatório é de fábrica ou tenant 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