Inquilinos (tenant)

2.0info: 1.10.0 Inquilinos description: Serviço responsável pelo gerenciamento da assinatura do Marketing Intelligence x-senior-domain: Marketing Intelligence x-senior-domain-path: mktint x-senior-service-path: tenant 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/mktintsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tenant/queries/healthcheck: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getAccessValidation: post: description: Registra histórico de acesso e retorna informações para o frontend realizar suas validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – showInitialBanner – signature – detailLimit – exportLimit properties: showInitialBanner: type: boolean description: Exibir o banner inicial signature: type: string allOf: – #/definitions/signatureEnum description: Assinatura detailLimit: type: object allOf: – #/definitions/detailLimitRecord description: Limite do detalhamento exportLimit: type: object allOf: – #/definitions/exportLimitRecord description: Limite de exportação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Registra histórico de acesso e retorna informações para o frontend realizar suas validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – showInitialBanner – signature – detailLimit – exportLimit properties: showInitialBanner: type: boolean description: Exibir o banner inicial signature: type: string allOf: – #/definitions/signatureEnum description: Assinatura detailLimit: type: object allOf: – #/definitions/detailLimitRecord description: Limite do detalhamento exportLimit: type: object allOf: – #/definitions/exportLimitRecord description: Limite de exportação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getDetailLimit: post: description: Consulta o uso do detalhamento para aplicar validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/detailLimitRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o uso do detalhamento para aplicar validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/detailLimitRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getSignature: post: description: Consulta o status da assinatura para aplicar validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – signature properties: signature: type: string allOf: – #/definitions/signatureEnum description: Status da Assinatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o status da assinatura para aplicar validações tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – signature properties: signature: type: string allOf: – #/definitions/signatureEnum description: Status da Assinatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getExportLimit: post: description: Consulta o uso da exportação para aplicar as validações no frontend tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/exportLimitRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o uso da exportação para aplicar as validações no frontend tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/exportLimitRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listExportExcel: post: description: Lista as exportações em Excel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 0 responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/exportExcelRecord minimum: 1 description: Registros totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as exportações em Excel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/exportExcelRecord minimum: 1 description: Registros totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportTenant: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportAccessHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportDetailHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportQueryHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportExportHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/exportCreditHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 /tenant/actions/buttonClick: post: description: Registra qual botão foi clicado pelo usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – button properties: button: type: string allOf: – #/definitions/buttonClickEnum description: Botão responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Define se a ação foi concluída com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/logDetailHistory: post: description: Loga um histórico de uso do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 255 description: CNPJ da empresa responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/logQueryHistory: post: description: Loga um histórico de consulta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – page – size – executionTime – previewMode properties: filter: type: string maxLength: 255 description: filtro usado na consulta page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de Registros executionTime: type: integer format: int64 description: Tempo de execução em milissegundos previewMode: type: string allOf: – #/definitions/previewModeEnum description: modo de pré-visualização responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/logExportHistory: post: description: Loga um histórico de exportação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type properties: fileName: type: string maxLength: 255 description: Nome do Arquivo fileExpirationDate: type: string format: date description: Data de Expiração amount: type: integer format: int64 description: Quantidade default: 0 type: type: string allOf: – #/definitions/typeEnum description: Tipo da Exportação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 /tenant/actions/importTenant: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/importAccessHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/importDetailHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/importQueryHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/importExportHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/importCreditHistory: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/events/exportExternalSystemFinished: post: description: Evento para informar quando a exportação para um Sistema Externo foi finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/exportLimitRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/exportExcelFinished: post: description: Evento para informar quando a exportação para Excel foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/exportLimitRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/exportExcelFinishedWithDownload: post: description: Evento para informar quando a exportação para Excel foi finalizada com link de download x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/exportExcelFinishedWithDownloadRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/detailedCompany: post: description: Evento para informar quando o detalhamento de uma empresa foi realizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/detailLimitRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/importTenantEvent: 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 /tenant/events/exportTenantEvent: 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 /tenant/events/importAccessHistoryEvent: 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 /tenant/events/exportAccessHistoryEvent: 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 /tenant/events/importDetailHistoryEvent: 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 /tenant/events/exportDetailHistoryEvent: 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 /tenant/events/importQueryHistoryEvent: 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 /tenant/events/exportQueryHistoryEvent: 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 /tenant/events/importExportHistoryEvent: 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 /tenant/events/exportExportHistoryEvent: 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 /tenant/events/importCreditHistoryEvent: 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 /tenant/events/exportCreditHistoryEvent: 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 /tenant/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 /tenant/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 /tenant/entities/tenant: 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/tenant responses: 200: description: The created resource schema: #/definitions/tenant 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/tenant responses: 200: description: The created resource schema: #/definitions/tenant 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{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/editTenant responses: 200: description: Ok schema: #/definitions/editTenant 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/tenant responses: 200: description: Ok schema: #/definitions/tenant 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/tenant 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 /tenant/entities/tenant/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/accessHistory: 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/accessHistory responses: 200: description: The created resource schema: #/definitions/accessHistory 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/accessHistory responses: 200: description: The created resource schema: #/definitions/accessHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accessHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/accessHistory/{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/editAccessHistory responses: 200: description: Ok schema: #/definitions/editAccessHistory 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/accessHistory responses: 200: description: Ok schema: #/definitions/accessHistory 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/accessHistory 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 /tenant/entities/tenant/{parentId}/accessHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/accessHistory responses: 200: description: The created resources schema: type: array items: #/definitions/accessHistory 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/accessHistory responses: 200: description: The created resources schema: type: array items: #/definitions/accessHistory 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accessHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{parentId}/accessHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAccessHistory responses: 200: description: Ok schema: #/definitions/editAccessHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accessHistory responses: 200: description: Ok schema: #/definitions/accessHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accessHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/accessHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accessHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/detailHistory: 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/detailHistory responses: 200: description: The created resource schema: #/definitions/detailHistory 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/detailHistory responses: 200: description: The created resource schema: #/definitions/detailHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/detailHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/detailHistory/{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/editDetailHistory responses: 200: description: Ok schema: #/definitions/editDetailHistory 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/detailHistory responses: 200: description: Ok schema: #/definitions/detailHistory 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/detailHistory 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 /tenant/entities/tenant/{parentId}/detailsHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/detailHistory responses: 200: description: The created resources schema: type: array items: #/definitions/detailHistory 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/detailHistory responses: 200: description: The created resources schema: type: array items: #/definitions/detailHistory 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/detailHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{parentId}/detailsHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDetailHistory responses: 200: description: Ok schema: #/definitions/editDetailHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/detailHistory responses: 200: description: Ok schema: #/definitions/detailHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/detailHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/detailHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/detailHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/queryHistory: 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/queryHistory responses: 200: description: The created resource schema: #/definitions/queryHistory 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/queryHistory responses: 200: description: The created resource schema: #/definitions/queryHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/queryHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/queryHistory/{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/editQueryHistory responses: 200: description: Ok schema: #/definitions/editQueryHistory 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/queryHistory responses: 200: description: Ok schema: #/definitions/queryHistory 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/queryHistory 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 /tenant/entities/tenant/{parentId}/queriesHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/queryHistory responses: 200: description: The created resources schema: type: array items: #/definitions/queryHistory 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/queryHistory responses: 200: description: The created resources schema: type: array items: #/definitions/queryHistory 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/queryHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{parentId}/queriesHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editQueryHistory responses: 200: description: Ok schema: #/definitions/editQueryHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/queryHistory responses: 200: description: Ok schema: #/definitions/queryHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/queryHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/queryHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/queryHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/exportHistory: 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/exportHistory responses: 200: description: The created resource schema: #/definitions/exportHistory 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/exportHistory responses: 200: description: The created resource schema: #/definitions/exportHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/exportHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/exportHistory/{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/editExportHistory responses: 200: description: Ok schema: #/definitions/editExportHistory 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/exportHistory responses: 200: description: Ok schema: #/definitions/exportHistory 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/exportHistory 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 /tenant/entities/tenant/{parentId}/exportHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exportHistory responses: 200: description: The created resources schema: type: array items: #/definitions/exportHistory 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exportHistory responses: 200: description: The created resources schema: type: array items: #/definitions/exportHistory 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/exportHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{parentId}/exportHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editExportHistory responses: 200: description: Ok schema: #/definitions/editExportHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/exportHistory responses: 200: description: Ok schema: #/definitions/exportHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/exportHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/exportHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/exportHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/creditHistory: 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/creditHistory responses: 200: description: The created resource schema: #/definitions/creditHistory 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/creditHistory responses: 200: description: The created resource schema: #/definitions/creditHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/creditHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/creditHistory/{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/editCreditHistory responses: 200: description: Ok schema: #/definitions/editCreditHistory 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/creditHistory responses: 200: description: Ok schema: #/definitions/creditHistory 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/creditHistory 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 /tenant/entities/tenant/{parentId}/creditHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/creditHistory responses: 200: description: The created resources schema: type: array items: #/definitions/creditHistory 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/creditHistory responses: 200: description: The created resources schema: type: array items: #/definitions/creditHistory 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/creditHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/tenant/{parentId}/creditHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCreditHistory responses: 200: description: Ok schema: #/definitions/editCreditHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/creditHistory responses: 200: description: Ok schema: #/definitions/creditHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/creditHistory 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/entities/creditHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/creditHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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/editUser responses: 200: description: Ok schema: #/definitions/editUser 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 /tenant/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/genericErrordefinitions: upDownEnum: description: UP ou DOWN type: string enum: – UP – DOWN typeEnum: description: Exportar type: string enum: – CRM – EXCEL previewModeEnum: description: Modo de Pré-visualização type: string enum: – LIST – MAP buttonClickEnum: description: Botões que terão a ação de clique monitorados type: string enum: – SIGNATURE – START_TEST signatureEnum: description: Status da Assinatura type: string enum: – ACTIVE – EXPIRED – LIFETIME arithmeticOperatorEnum: description: Operadores Aritméticos type: string enum: – SUM – SUBTRACT 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 – LOCALDATETIME – 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 detailLimitRecord: description: Informações sobre o controle de detalhamento type: object required: – remainingAmount properties: remainingAmount: type: integer format: int64 description: Quantidade restante exportLimitRecord: description: Informações sobre o controle de exportação type: object required: – remainingAmount properties: remainingAmount: type: integer format: int64 description: Quantidade restante exportExcelRecord: description: Exportações para Excel type: object required: – id – fileName – amount – createdBy – createdAt properties: id: type: string maxLength: 255 description: Identificador fileName: type: string maxLength: 255 description: Nome do arquivo amount: type: integer format: int64 description: Quantidade de registros exportados expirationDate: type: string format: date description: Data de expiração createdBy: type: string maxLength: 255 description: Criado por createdAt: type: string format: date-time description: Criado em exportExcelFinishedWithDownloadRecord: description: Retorno do evento exportExcelFinishedWithDownload type: object required: – downloadUrl properties: downloadUrl: type: string maxLength: 255 description: URL de download tenant: description: inquilino type: object required: – tenantName – name properties: id: type: string format: uuid description: identificador tenantName: type: string maxLength: 255 description: Nome Tenant name: type: string maxLength: 255 description: Nome da Empresa expirationDate: type: string format: date description: Data de expiração da assinatura isCrm: type: boolean description: Indica se possui CRM default: false exportCredits: type: integer format: int64 description: Quantidade de créditos disponíveis default: 0 accessHistory: type: array items: type: object allOf: – #/definitions/accessHistory description: Histórico de Acesso detailsHistory: type: array items: type: object allOf: – #/definitions/detailHistory description: Históricos de Detalhamento queriesHistory: type: array items: type: object allOf: – #/definitions/queryHistory description: Histórico de Consultas exportHistory: type: array items: type: object allOf: – #/definitions/exportHistory description: Histórico de exportação creditHistory: type: array items: type: object allOf: – #/definitions/creditHistory description: Histórico de créditos createdBy: type: string maxLength: 255 description: createdAt: type: string format: date-time description: changedBy: type: string maxLength: 255 description: changedAt: type: string format: date-time description: editTenant: type: object required: – id allOf: – #/definitions/tenant accessHistory: description: Histórico de Acesso type: object required: – user – dateTime properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino user: type: object allOf: – #/definitions/user description: Usuário dateTime: type: string format: date-time description: Data/Hora editAccessHistory: type: object required: – id allOf: – #/definitions/accessHistory detailHistory: description: Histórico Detalhado type: object required: – user – dateTime – cnpj properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino user: type: object allOf: – #/definitions/user description: Usuário dateTime: type: string format: date-time description: Data/Hora cnpj: type: string maxLength: 255 description: CNPJ editDetailHistory: type: object required: – id allOf: – #/definitions/detailHistory queryHistory: description: Histórico de Consultas type: object required: – user – dateTime – filter – page – size – executionTime properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino user: type: object allOf: – #/definitions/user description: Usuário dateTime: type: string format: date-time description: Data/Hora filter: type: string maxLength: 255 description: Filtro page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros por página executionTime: type: integer format: int64 description: Tempo de Execução em milissegundos previewMode: type: string allOf: – #/definitions/previewModeEnum description: Modo de Pré-visualização editQueryHistory: type: object required: – id allOf: – #/definitions/queryHistory exportHistory: description: Histórico de exportação type: object required: – user – type properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino user: type: object allOf: – #/definitions/user description: Usuário fileName: type: string maxLength: 255 description: Nome do Arquivo fileExpirationDate: type: string format: date description: Data de Expiração amount: type: integer format: int64 description: Quantidade default: 0 surplusCredit: type: integer format: int64 description: Quantidade excedente default: 0 type: type: string allOf: – #/definitions/typeEnum description: Tipo da Exportação createdBy: type: string maxLength: 255 description: createdAt: type: string format: date-time description: changedBy: type: string maxLength: 255 description: changedAt: type: string format: date-time description: editExportHistory: type: object required: – id allOf: – #/definitions/exportHistory creditHistory: description: Histórico de crédito type: object required: – currentCredit – manipulatedCredit – manipulationOperator – newCredit properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino currentCredit: type: integer format: int64 description: Quantidade de crédito atual manipulatedCredit: type: integer format: int64 description: Quantidade de crédito a ser manipulada manipulationOperator: type: string allOf: – #/definitions/arithmeticOperatorEnum description: Operador da manipulação newCredit: type: integer format: int64 description: Nova quantidade de crédito createdBy: type: string maxLength: 255 description: createdAt: type: string format: date-time description: changedBy: type: string maxLength: 255 description: changedAt: type: string format: date-time description: editCreditHistory: type: object required: – id allOf: – #/definitions/creditHistory user: description: Usuário type: object required: – tenant – username – name – showBanner – clickButtonSignature – clickButtonStartTest properties: id: type: string format: uuid description: Identificador tenant: type: object allOf: – #/definitions/tenant description: Inquilino username: type: string maxLength: 255 description: Login name: type: string maxLength: 255 description: Nome showBanner: type: boolean description: Exibir Banner clickButtonSignature: type: integer format: int64 description: Quantidade de cliques no botão de assinatura clickButtonStartTest: type: integer format: int64 description: Quantidade de cliques no botão teste editUser: type: object required: – id allOf: – #/definitions/user 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 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 maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 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 maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 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 maxLength: 255 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 maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 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 maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 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 maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 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