Plataforma (platform)

2.0info: 14.1.4 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: api.senior.com.br /platform/report/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /listLookupFunctionPrimitives: post: description: Lista de primitivas compativéis com função de pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: services: type: array items: #/definitions/serviceId description: Serviços responses: 200: description: Ok schema: type: object properties: primitives: #/definitions/primitiveId 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getUsageLimits: post: description: Retorna a lista de limites de uso definida x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: responses: 200: description: Ok schema: type: object required: – usageLimit properties: usageLimit: #/definitions/usageLimit 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /cancelGeneration: post: description: Cancelar os relatórios que estão em execução ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: string 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 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /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 ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – reports – listInformation properties: reports: #/definitions/report listInformation: #/definitions/listInformation 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /getRunningReports: post: description: Retorna todos os relatórios que estão em execução, com informações sobre o progresso, usuário, etc. ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 orderByDesc: type: boolean description: Definir a ordenação dos registros, se não informado o valor informado será falso pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – runningReports – listInformation properties: runningReports: #/definitions/generationStatus listInformation: #/definitions/listInformation 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /getReportDefinitionUri: post: description: Retorna uma URI para download de um modelo de relatório ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 moelo de relatório 404: description: Relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /toggleEnabledAll: post: description: Altera o estado de todos os relatórios. ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 description: Número de relatórios que foram atualizados 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getReportStatus: post: description: Obtém o status de um relatório que está sendo gerado ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/generationStatus 404: description: Relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listLookupFunctionServices: post: description: Lista todos os serviços que possui primitivas compativéis com função de pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: responses: 200: description: Ok schema: type: object properties: services: #/definitions/serviceId default: description: Error response schema: #/definitions/genericError /generateReport: post: description: Gera um relatório identificado pelo id informado. ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/format timeToLive: type: integer description: Quanto tempo o relatório ficará disponível depois de gerado, se não informado o valor padrão será 7200 (5 dias) parameters: type: array items: #/definitions/parameterValue description: Valor para os parâmetros necessários destination: type: array items: #/definitions/destinationInfo description: Destino onde o relatório ficará disponível overrideUserTimezone: type: boolean description: Sobrescrever o timezone padrão. timezoneOffset: type: integer description: Timezone que será aplicado na geração do relatório, se não informado o padrão será UTC 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 404: description: Relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretemante 402: description: Pagamento requerido default: description: Error response schema: #/definitions/genericError /deleteReportFile: post: description: Deleta um arquivo de relatório x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – reportFileId properties: reportFileId: #/definitions/reportFileId responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a execução correu com sucesso 404: description: Arquivo de relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /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 ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Identificador do relatório reportFileId: #/definitions/reportFileId responses: 200: description: Ok schema: type: object required: – parameters – systemDefinedParameters properties: parameters: #/definitions/parameterDef systemDefinedParameters: type: string description: Os parâmetros existentes no relatório cujos valores são definidos automaticamente pelo serviço 404: description: Relatório não encontrado 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /toggleEnabled: post: description: Habilita ou desabilita um relatório. Um relatório desabilitado não pode ser gerado ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 404: description: Relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /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 ### Resources: – res://senior.com.br/report/report x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 404: description: Relatório não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: format: type: string enum: – Pdf – Csv – Html – Xls – Xlsx – Xml – Odt – Rtf type: type: string enum: – String – Integer – Double – Boolean – Date – DateTime – Time – Object – List – ArrayList stage: type: string enum: – Starting – Compiling – Filling – Exporting – Done – Cancelled – Generated – Error destination: type: string enum: – EmailWithContent – EmailWithUrl – Social menuType: type: string enum: – DEFAULT – ACTION reportFileId: type: object required: – objectId – fileName properties: objectId: type: string description: Identificador único do arquivo fileName: type: string description: Nome do arquivo parameterValue: type: object required: – name – value properties: name: type: string description: Nome do parâmetro value: type: string description: Valor do parâmetro format: byte parameterDef: type: object required: – name properties: name: type: string description: Nome do parâmetro description: type: string description: Descrição do parâmetro type: #/definitions/type required: type: boolean description: Definir o parâmetro como obrigatório generationStatus: type: object required: – ticketId – report – user – startTime – stage properties: ticketId: type: string description: Id do relatório report: #/definitions/reportHeader user: type: string description: usuário startTime: type: string description: Início da geração do relatório format: date-time stage: #/definitions/stage reportHeader: type: object required: – id – name properties: id: type: string description: name: type: string description: destinationInfo: type: object required: – type properties: type: #/definitions/destination emailConfig: #/definitions/emailConfig socialConfig: #/definitions/socialConfig emailConfig: type: object required: – to – subject – message properties: from: #/definitions/emailContact to: type: array items: #/definitions/emailContact description: cc: type: array items: #/definitions/emailContact description: bcc: type: array items: #/definitions/emailContact description: subject: type: string description: message: type: string description: emailContact: type: object required: – email properties: email: type: string description: name: type: string description: socialConfig: type: object required: – space – text properties: space: type: string description: text: type: string description: usageLimit: type: object required: – label – limit – usage – freeTier properties: label: type: string description: Descrição da propriedade cadastrada como limite limit: type: number description: Quantidade máxima que pode ser atingida para o recurso format: double usage: type: number description: Quantidade utilizada para o recurso format: double freeTier: type: boolean description: Permite continuar gerando relatórios após limite máximo excedido pagination: type: object properties: pageNumber: type: integer description: O número da página retornado. A primeira página corresponde ao índice 0 pageSize: type: integer description: Quantidade de registros por página listInformation: type: object required: – totalElements – totalPages properties: totalElements: type: integer description: Quantidade total de resultados encontrados totalPages: type: integer description: Quantidade total de páginas encontradas serviceId: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço primitiveId: 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 report: 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: #/definitions/reportMenu description: Items de menu que o relatório está associado ttl: type: integer 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 description: Data e hora que o relatório foi criado format: date-time updateUser: type: string description: Nome do ultimo usuário que atualizou o relatório updateTime: type: string description: Data e hora da ultima atualização do relatório format: date-time lookupParameters: type: array items: #/definitions/lookupParameter description: Parâmetros do relatório que são do tipo lookup baseUrl: type: string description: Base Url for execution the report reportMenu: type: object required: – menuId – label – menuType properties: menuId: type: string description: Id do menu label: type: string description: Rótulo do menu menuType: #/definitions/menuType lookupParameter: 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 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