2.0info: 1.4.3 centering_panel description: Serviço de Backend do Painel Centralizador para BPO x-senior-domain: bpo x-senior-domain-path: bpo x-senior-service-path: centering_panel 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/bposecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /centering_panel/queries/healthcheck: post: description: Query for health check – SRE tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/queries/getManagerTenant: post: description: Retorna o Tenant gestor de um Tenant administrado que estiver chamando o Endpoint.\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – managerTenant properties: managerTenant: type: string description: Nome do Tenant gestor do Tenant que está chamando o Endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o Tenant gestor de um Tenant administrado que estiver chamando o Endpoint.\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – managerTenant properties: managerTenant: type: string description: Nome do Tenant gestor do Tenant que está chamando o Endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/queries/getManagedTenants: post: description: Retorna os Tenants administrados de um Tenant gestor que estiver chamando o Endpoint.\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: managerTenant: type: array items: type: string description: Nome(s) do(s) Tenant(s) administrado(s) do Tenant que está chamando o Endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os Tenants administrados de um Tenant gestor que estiver chamando o Endpoint.\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: managerTenant: type: array items: type: string description: Nome(s) do(s) Tenant(s) administrado(s) do Tenant que está chamando o Endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/queries/isManagedTenant: post: description: Verifica se um Tenant está cadastrado como um Tenant administrado por Parceiro BPO tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isManagedTenant properties: isManagedTenant: type: boolean description: Indica o Tenant é um Tenant administrado por Parceiro BPO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se um Tenant está cadastrado como um Tenant administrado por Parceiro BPO tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isManagedTenant properties: isManagedTenant: type: boolean description: Indica o Tenant é um Tenant administrado por Parceiro BPO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/queries/retrieveTask: post: description: Obtem os dados de uma tarefa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da Tarefa que deseja obter os detalhes responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: Tarefa detalhada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem os dados de uma tarefa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: ID da Tarefa que deseja obter os detalhes in: query required: true type: string responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: Tarefa detalhada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/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 /centering_panel/queries/exportTenant: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /centering_panel/queries/exportManagerTenant: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /centering_panel/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/actions/confirmManagementIntent: post: description: Confirma uma intenção de gerenciamento.\n Por se tratar de uma operação de dois fatores, exige que o Tenant administrado envie no input o nome do Tenant\n administrador para que a confirmação seja validada.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerTenantName properties: managerTenantName: type: string description: Nome do Tenant que quer confirmar como gestor do Tenant que está chamando o Endpoint responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/actions/loadPendingTasks: post: description: Realiza a carga inicial de tarefas de um tenant Manager.\n Obtem todas as tarefas pendentes de todos os tenants managed passados como parametro.\n Se nenhum tenant for passado como parâmetro: obtem as tarefas pendentes de todos seus respectivos tenants managed\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: managedTenants: type: array items: type: string description: Lista com nomes dos tenants gerenciados para os quais se deseja fazer a carga inicial (opcional) responses: 200: description: Ok schema: type: object properties: message: type: string description: Mensagem de Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/actions/updateTaskInfo: post: description: Altera as informações de uma tarefa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taskId – updateTaskData properties: taskId: type: string description: ID da Tarefa que deseja alterar updateTaskData: type: object allOf: – #/definitions/updateTaskData description: Dados a serem atualizados na Tarefa responses: 200: description: Ok schema: type: object properties: message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/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 /centering_panel/actions/importTenant: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /centering_panel/actions/importManagerTenant: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /centering_panel/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 /centering_panel/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 /centering_panel/events/importManagerTenantEvent: 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 /centering_panel/events/exportManagerTenantEvent: 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 /centering_panel/events/importTaskEvent: 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 /centering_panel/events/exportTaskEvent: 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 /centering_panel/events/importTaskHistoryEvent: 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 /centering_panel/events/exportTaskHistoryEvent: 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 /centering_panel/entities/tenant: post: 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: 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: 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/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/tenant/{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/tenant responses: 200: description: Ok schema: #/definitions/tenant 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/tenant responses: 200: description: Ok schema: #/definitions/tenant 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/tenant 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 /centering_panel/entities/tenant/bulk: post: 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 /centering_panel/entities/managerTenant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/managerTenant responses: 200: description: The created resource schema: #/definitions/managerTenant 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/managerTenant responses: 200: description: The created resource schema: #/definitions/managerTenant 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/managerTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/managerTenant/{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/managerTenant responses: 200: description: Ok schema: #/definitions/managerTenant 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/managerTenant responses: 200: description: Ok schema: #/definitions/managerTenant 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/managerTenant 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 /centering_panel/entities/managerTenant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/managerTenant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/task: 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/task 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/task/{parentId}/tenant: 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: object allOf: – #/definitions/task responses: 200: description: The created resource schema: #/definitions/task 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: object allOf: – #/definitions/task responses: 200: description: The created resource schema: #/definitions/task 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 responses: 200: description: Ok schema: type: array items: #/definitions/task 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/task/{parentId}/tenant/{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/task responses: 200: description: Ok schema: #/definitions/task 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/task responses: 200: description: Ok schema: #/definitions/task 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/task 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 /centering_panel/entities/taskHistory: 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/taskHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/taskHistory/{parentId}/task: 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: object allOf: – #/definitions/taskHistory responses: 200: description: The created resource schema: #/definitions/taskHistory 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: object allOf: – #/definitions/taskHistory responses: 200: description: The created resource schema: #/definitions/taskHistory 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 responses: 200: description: Ok schema: type: array items: #/definitions/taskHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /centering_panel/entities/taskHistory/{parentId}/task/{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/taskHistory responses: 200: description: Ok schema: #/definitions/taskHistory 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/taskHistory responses: 200: description: Ok schema: #/definitions/taskHistory 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/taskHistory 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 definitions: upDown: description: Up or down type: string enum: – UP – DOWN taskStatus: description: Status da tarefa type: string enum: – UNREADED – READED – PENDING – TREATED myRequestKind: description: Status da Solicitação type: string enum: – InProgress – Completed – Canceled 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 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 updateTaskData: description: Dados atualizáveis em uma Tarefa type: object properties: detailProcessVariables: type: string description: Detalhes da Tarefa endDate: type: string format: date-time description: Data de fim da tarefa/processo responsableName: type: string description: Nome do responsável pela tarefa responsableFullName: type: string description: Nome e sobrenome do responsável pela tarefa activity: type: string description: Atividade atual activityId: type: integer format: int64 description: Id da atividade step: type: integer format: int64 description: Passo taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da tarefa requestStatus: type: string allOf: – #/definitions/myRequestKind description: Status da solicitação tenant: description: Entidade Tenant type: object required: – tenantName – companyName properties: id: type: string format: uuid description: Identificador do Tenant no Painel BPO tenantName: type: string description: Nome do Tenant managementConfirmed: type: boolean description: Indica se o vínculo entre Tenants gestor x administrado está confirmado/validado default: false companyName: type: string description: Nome da Empresa initialLoadPerformed: type: boolean description: Carga inicial Realizada default: false managerTenant: description: Entidade Tenant Gestor type: object required: – managerTenantName properties: id: type: string format: uuid description: Identificador do Tenant no Painel BPO managerTenantName: type: string description: Nome do Tenant managementConfirmed: type: boolean description: Indica se o vínculo entre Tenants gestor x administrado está confirmado/validado default: false task: description: Tarefa do BPM type: object required: – processId – processVersion – processName – processInstanceId – requesterName – startDate – responsableName – activity – activityId – step – requestStatus properties: id: type: string format: uuid description: Identificador da tarefa no Painel BPO processId: type: integer format: int64 description: ID do Processo BPM processVersion: type: integer format: int64 description: Versão do Processo BPM processName: type: string description: Nome do Processo BPM processInstanceId: type: integer format: int64 description: ID da instância do processo tenant: type: object allOf: – #/definitions/tenant description: Tenant do cliente readOnly: true requesterName: type: string description: Nome do solicitante detailProcessVariables: type: string description: Detalhes da Tarefa startDate: type: string format: date-time description: Data de início da tarefa/processo endDate: type: string format: date-time description: Data de fim da tarefa/processo expirationDate: type: string format: date-time description: Data de expiração da tarefa/processo responsableName: type: string description: Nome do responsável pela tarefa responsableFullName: type: string description: Nome e sobrenome do responsável pela tarefa activity: type: string description: Atividade atual activityId: type: integer format: int64 description: Id da atividade step: type: integer format: int64 description: Passo taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da tarefa requestStatus: type: string allOf: – #/definitions/myRequestKind description: Status da solicitação type: string description: Título da Solicitação taskHistory: description: Histórico de alterações de Tarefas type: object required: – updatedBy – updatedAt – fieldName – oldValue – newValue properties: id: type: string format: uuid description: ID task: type: object allOf: – #/definitions/task description: Tarefa readOnly: true updatedBy: type: string description: Usuário updatedAt: type: string format: date-time description: Data da alteração fieldName: type: string description: Campo da tarefa que foi alterado oldValue: type: string description: Valor anterior newValue: type: string description: Novo valor 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