2.0info: 2.5.0 camada_gestao description: Serviço auxiliar da Camada de Gestão do ERP XT. Responsável por habilitar a camada de gestão para novos clientes, provisionando toda a infraestrutura, em nuvem, necessária. x-senior-domain: erpxt x-senior-domain-path: erpxt x-senior-service-path: camada_gestao 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/erpxtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /camada_gestao/queries/isActive: post: description: Retorna se a Camada de Gestão está ativa para o tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – active properties: active: type: boolean description: Camada de Gestão ativa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se a Camada de Gestão está ativa para o tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – active properties: active: type: boolean description: Camada de Gestão ativa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/reportView: post: description: Retorna as informações para abertura de um relatório no PowerBI Embedded tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reportId properties: reportId: type: string description: ID do relatório na plataforma responses: 200: description: Ok schema: type: object required: – recReportToken properties: recReportToken: type: object allOf: – #/definitions/recReportToken description: Código do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações para abertura de um relatório no PowerBI Embedded tags: – Queries x-senior-visibility: PRIVATE parameters: – name: reportId description: ID do relatório na plataforma in: query required: true type: string responses: 200: description: Ok schema: type: object required: – recReportToken properties: recReportToken: type: object allOf: – #/definitions/recReportToken description: Código do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/getUser: post: description: Retorna Usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Name único do usuário responses: 200: description: Ok schema: type: object required: – usuario properties: usuario: type: object allOf: – #/definitions/recUser description: Usuário base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna Usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Name único do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuario properties: usuario: type: object allOf: – #/definitions/recUser description: Usuário base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/getUserReports: post: description: Retorna lista com apenas os relatórios liberados para o usuário que fizer a chamada tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/powerBiReport minimum: 1 description: Lista dos relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna lista com apenas os relatórios liberados para o usuário que fizer a chamada tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/powerBiReport minimum: 1 description: Lista dos relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/pesquisarUsuarios: post: description: Retorna lista com os Usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: nome: type: string description: Nome email: type: string description: E-mail relatoriosId: type: array items: type: string description: ID dos Relatórios para filtro paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – users – totalRegistros properties: users: type: array items: type: object allOf: – #/definitions/recUser minimum: 1 description: Lista com os usuários totalRegistros: type: integer format: int64 description: Total de Registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/searchTenantReports: post: description: Retorna os Relatórios Disponíveis para o tenant que realizou a chamada tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – reports properties: reports: type: array items: type: object allOf: – #/definitions/recRelatorio minimum: 1 description: Lista de Records com os Relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os Relatórios Disponíveis para o tenant que realizou a chamada tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – reports properties: reports: type: array items: type: object allOf: – #/definitions/recRelatorio minimum: 1 description: Lista de Records com os Relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/getReportsToActivate: post: description: Pesquisa quais relatórios o tenant pode ativar tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – reports properties: reports: type: array items: type: string allOf: – #/definitions/enumReports minimum: 1 description: Relatórios que o tenant ainda pode ativar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa quais relatórios o tenant pode ativar tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – reports properties: reports: type: array items: type: string allOf: – #/definitions/enumReports minimum: 1 description: Relatórios que o tenant ainda pode ativar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/verificaPermissaoRelatorio: post: description: Verifica e retorna se o usuário tem permissão para visualizar o relatório tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reportId properties: reportId: type: string maxLength: 36 description: ID do Relatório responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: Retorno com permissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica e retorna se o usuário tem permissão para visualizar o relatório tags: – Queries x-senior-visibility: PRIVATE parameters: – name: reportId description: ID do Relatório in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: Retorno com permissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/getUsageReports: post: description: Retorna os totalizadores da utilização dos relátórios no camada de gestão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant – Uso apenas para o tenant Senior responses: 200: description: Ok schema: type: object properties: reports: type: array items: type: object allOf: – #/definitions/recUsageReport description: Informação de uso dos relatórios agrupada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os totalizadores da utilização dos relátórios no camada de gestão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant – Uso apenas para o tenant Senior in: query type: string responses: 200: description: Ok schema: type: object properties: reports: type: array items: type: object allOf: – #/definitions/recUsageReport description: Informação de uso dos relatórios agrupada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/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 /camada_gestao/queries/exportCamadaGestao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/exportPowerBiReport: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/exportUser: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/exportUserReport: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/exportAnalytics: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/activate: post: description: Ativa a camada de gestão para o tenant solicitante tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: reports: type: array items: type: string allOf: – #/definitions/enumReports description: Lista de relatorios padrões à serem ativados responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID do pedido de ativação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/updateReport: post: description: Atualiza o relatório do PowerBI para a ultima versão disponível no Azure Storage para os tenants indicados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reports properties: reports: type: array items: type: string allOf: – #/definitions/enumReports minimum: 1 description: Lista de relatórios que devem ser atualizados tenants: type: array items: type: string description: Lista de tenants que devem ser atualizados com os relatórios. Caso nenhum tenant seja informado, todos serão atualizados! responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/addReport: post: description: Adiciona um relatório ao tenant da mensagem, com a descrição informada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reportType properties: reportType: type: string allOf: – #/definitions/enumReports description: Tipo do Relatório description: type: string maxLength: 2000 description: Descrição do relatório responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/saveUser: post: description: Action para salvar Usuários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – email properties: name: type: string description: Nome ou descrição do usuário fullName: type: string maxLength: 200 description: Nome completo / de exibição email: type: string description: E-mail do usuário cadastrado na plataforma relatorios: type: array items: type: string description: ID dos Relatórios que ficarão disponíveis para o usuário responses: 200: description: Ok schema: type: object required: – saved properties: saved: type: boolean description: Identificador usuário foi salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/deleteWorkspace: post: description: Exclui os Workspaces do PowerBi para os tenants informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Tenants que terão os Workspaces excluídos responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/validate: post: description: Valida se a configuração de parâmetros do PowerBI estão corretas para todos os Datasets do Workspace do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenants – emails properties: tenants: type: array items: type: string minimum: 1 description: Lista de tenants/clientes para validar os parâmetros emails: type: array items: type: string minimum: 1 description: Lista de emails que serão informados sobre os erros dos tenants responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/recValidateTenant minimum: 1 description: Status da validação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/importCamadaGestao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/importPowerBiReport: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/importUser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/importUserReport: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/actions/importAnalytics: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/events/importCamadaGestaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/exportCamadaGestaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/importPowerBiReportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/exportPowerBiReportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/importUserEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/exportUserEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/importUserReportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/exportUserReportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/importAnalyticsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/events/exportAnalyticsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/camadaGestao: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/camadaGestao responses: 200: description: The created resource schema: #/definitions/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/camadaGestao responses: 200: description: The created resource schema: #/definitions/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/camadaGestao/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/camadaGestao responses: 200: description: Ok schema: #/definitions/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/camadaGestao responses: 200: description: Ok schema: #/definitions/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/camadaGestao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /camada_gestao/entities/camadaGestao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/camadaGestao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/powerBiReport: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/powerBiReport responses: 200: description: The created resource schema: #/definitions/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/powerBiReport responses: 200: description: The created resource schema: #/definitions/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/powerBiReport/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/powerBiReport responses: 200: description: Ok schema: #/definitions/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/powerBiReport responses: 200: description: Ok schema: #/definitions/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/powerBiReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /camada_gestao/entities/powerBiReport/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/powerBiReport responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/user: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/user responses: 200: description: The created resource schema: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/user responses: 200: description: The created resource schema: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/user/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/user responses: 200: description: Ok schema: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/user responses: 200: description: Ok schema: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /camada_gestao/entities/user/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/user responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/userReport: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userReport responses: 200: description: The created resource schema: #/definitions/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userReport responses: 200: description: The created resource schema: #/definitions/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/userReport/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userReport responses: 200: description: Ok schema: #/definitions/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userReport responses: 200: description: Ok schema: #/definitions/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /camada_gestao/entities/userReport/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userReport responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/analytics: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/analytics responses: 200: description: The created resource schema: #/definitions/analytics 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/analytics responses: 200: description: The created resource schema: #/definitions/analytics 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/analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /camada_gestao/entities/analytics/{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/analytics responses: 200: description: Ok schema: #/definitions/analytics 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/analytics responses: 200: description: Ok schema: #/definitions/analytics 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/analytics 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 /camada_gestao/entities/analytics/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/analytics responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumStatusCamadaGestao: description: Enum de status da camada de gestão type: string enum: – ACTIVATING – ACTIVE – ERROR enumPowerBiReportStatus: description: Enum de Status dos Relatórios da Camada de Gestão type: string enum: – ACTIVATING – ACTIVE – ERROR enumReports: description: Enum de relatórios type: string enum: – COMPRAS – CONTABIL – CONTASAPAGAR – CONTASARECEBER – FATURAMENTO – GERENCIAL – PEDIDO – PRODUCAO – PERSONALIZADO upDown: description: Up or down type: string enum: – UP – DOWN enumDirecao: description: Direção da Ordenação type: string enum: – ASC – DESC 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR camadaGestao: description: Guarda as informações da ativação da camada de gestão type: object required: – tenant – status properties: id: type: string format: uuid description: Código único da tabela tenant: type: string description: Nome do tenant workspaceId: type: string description: ID do workspace do PowerBI status: type: string allOf: – #/definitions/enumStatusCamadaGestao description: Status da ativação da camada de gestão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: powerBiReport: description: Responsável por armazenar informações dos relatórios que estão sendo atualmente utilizados pelo tenant type: object required: – name – description – reportId – reportType – status properties: id: type: string format: uuid description: Código único da tabela name: type: string description: Nome do relatório description: type: string maxLength: 2000 description: Descrição do relatório reportId: type: string description: Nome do .pbix no Azure Storage reportType: type: string allOf: – #/definitions/enumReports description: Tipo do Report status: type: string allOf: – #/definitions/enumPowerBiReportStatus description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: user: description: Entidade dos usuários que possuem acesso à camada de gestão type: object required: – name – fullName – email properties: id: type: string format: uuid description: Código único da tabela name: type: string description: Nome ou descrição do usuário fullName: type: string maxLength: 200 description: Nome completo / de exibição email: type: string description: E-mail do usuário cadastrado na plataforma createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: userReport: description: Relação de permissão entre os usuários e os relatórios type: object required: – user – report properties: id: type: string format: uuid description: Código único da tabela user: type: object allOf: – #/definitions/user description: Entidade de usuário report: type: object allOf: – #/definitions/powerBiReport description: Entidade de relatório createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: analytics: description: Responsável por armazenar informações de quem acessou os relatórios type: object required: – report properties: id: type: string format: uuid description: Código único da tabela report: type: string maxLength: 255 description: Relatório acessado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recValidateTenant: description: Objeto que contém type: object required: – tenant – groupId – status – reports properties: tenant: type: string description: Código do workspace do cliente groupId: type: string description: Código do workspace do cliente status: type: string description: Código do relatório reports: type: array items: type: object allOf: – #/definitions/recValidateTenantReports minimum: 1 description: Token único de acesso ao relatório recValidateTenantReports: description: Objeto que contém type: object required: – id – reportId – nome – tipo – status properties: id: type: string maxLength: 36 description: Identificador Único reportId: type: string maxLength: 36 description: Identificador Único nome: type: string description: Nome tipo: type: string allOf: – #/definitions/enumReports description: Tipo status: type: string description: Tipo recReportToken: description: Objeto que contém type: object required: – groupId – reportId – embedToken properties: groupId: type: string description: Código do workspace do cliente reportId: type: string description: Código do relatório embedToken: type: string description: Token único de acesso ao relatório recRelatorio: description: Record do Relatório type: object required: – nome – tipo properties: id: type: string maxLength: 36 description: Identificador Único nome: type: string description: Nome descricao: type: string description: Descrição tipo: type: string allOf: – #/definitions/enumReports description: Tipo recUser: description: Record do Usuário type: object required: – name – fullName – email – relatorios – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: name: type: string description: Nome ou descrição do usuário fullName: type: string description: Nome complete / de exibição email: type: string description: E-mail do usuário cadastrado na plataforma relatorios: type: array items: type: object allOf: – #/definitions/recRelatorio minimum: 1 description: Relatórios vinculados ao usuário createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Criado em lastModifiedBy: type: string description: Modificado por lastModifiedDate: type: string format: date-time description: Modificado em recPaginacao: description: Dados para paginação de registros type: object required: – pagina – registrosPagina – ordenacao properties: pagina: type: integer format: int64 description: Qual página registrosPagina: type: integer format: int64 description: Limite de registros ordenacao: type: object allOf: – #/definitions/recOrdenacao description: Ordenação recOrdenacao: description: Dados para ordenação das pesquisas type: object required: – campo – direcao properties: campo: type: string description: Campo direcao: type: string allOf: – #/definitions/enumDirecao description: Direção recUsageReport: description: totalizador da utilização do relátório type: object required: – report – totalAccess properties: report: type: string description: Relatório totalAccess: type: integer format: int64 description: Quantidade total de acessos ao relatório lastAccessDate: type: string format: date description: Último acesso ao relatório 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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