2.0info: 2.8.4 xplatform_owner_management description: Serviço de proprietária do xplatform x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: xplatform_owner_management contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /xplatform_owner_management/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getLogs: post: description: Obter os logs de envio de notificações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId – tenantName properties: contractId: type: string description: Identificado do contrato tenantName: type: string description: tenant name responses: 200: description: Ok schema: type: object required: – contractLog properties: contractLog: type: array items: type: object allOf: – #/definitions/contractLog minimum: 1 description: Lista de logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter os logs de envio de notificações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: contractId description: Identificado do contrato in: query required: true type: string – name: tenantName description: tenant name in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contractLog properties: contractLog: type: array items: type: object allOf: – #/definitions/contractLog minimum: 1 description: Lista de logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getReportProductFeature: post: description: Consulta de interesse no produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialDate – finalDate properties: initialDate: type: string format: date description: Data inicial obrigatória finalDate: type: string format: date description: Data final obrigatória productName: type: array items: type: string allOf: – #/definitions/productName description: Produto productFeature: type: array items: type: string allOf: – #/definitions/featureProduct description: Recurso responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/productFeature minimum: 1 description: Lista de interessados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBillingDocSign: post: description: Consulta de billing do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialDate – finalDate – productName properties: initialDate: type: string format: date description: Data inicial obrigatória finalDate: type: string format: date description: Data final obrigatória productName: type: string allOf: – #/definitions/productName description: Produto domain: type: array items: type: string description: Domain responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/billingDocSign minimum: 1 description: Lista de ocorrências de billing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBillingDocSignDomains: post: description: Consulta de domínios do Billing DocSign tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: Lista de domínios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de domínios do Billing DocSign tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: Lista de domínios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getEnabledFeature: post: description: Verifica se a feature esta habilitada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome da feature responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Habilitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se a feature esta habilitada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome da feature in: query required: true type: string responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Habilitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getUnitCostByProduct: post: description: Obter os custos unitários por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – bpmCost – gedCost – botCost – signCost properties: bpmCost: type: number format: double description: Custo unitário BPM gedCost: type: number format: double description: Custo unitário GED botCost: type: number format: double description: Custo unitário BOT signCost: type: number format: double description: Custo unitário SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter os custos unitários por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – bpmCost – gedCost – botCost – signCost properties: bpmCost: type: number format: double description: Custo unitário BPM gedCost: type: number format: double description: Custo unitário GED botCost: type: number format: double description: Custo unitário BOT signCost: type: number format: double description: Custo unitário SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getTotalByProduct: post: description: Obter os totais por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – bpmTotal – bpmStorage – gedTotal – gedStorage – botTotal – botStorage – signTotal – signStorage properties: bpmTotal: type: integer format: int64 description: Totais BPM bpmStorage: type: number format: double description: Storage BPM gedTotal: type: integer format: int64 description: Totais GED gedStorage: type: number format: double description: Storage GED botTotal: type: integer format: int64 description: Totais BOT botStorage: type: number format: double description: Storage BOT signTotal: type: integer format: int64 description: Totais SIGN signStorage: type: number format: double description: Storage SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter os totais por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – bpmTotal – bpmStorage – gedTotal – gedStorage – botTotal – botStorage – signTotal – signStorage properties: bpmTotal: type: integer format: int64 description: Totais BPM bpmStorage: type: number format: double description: Storage BPM gedTotal: type: integer format: int64 description: Totais GED gedStorage: type: number format: double description: Storage GED botTotal: type: integer format: int64 description: Totais BOT botStorage: type: number format: double description: Storage BOT signTotal: type: integer format: int64 description: Totais SIGN signStorage: type: number format: double description: Storage SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getTopTenantsUsageByProduct: post: description: Retorna a quantidade usada por cada tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – quantity properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final productName: type: string allOf: – #/definitions/productName description: Produto quantity: type: integer format: int64 description: Quantidade de tenants responses: 200: description: Ok schema: type: object required: – tenantQuantities properties: tenantQuantities: type: array items: type: object allOf: – #/definitions/tenantQuantity minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade usada por cada tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: productName description: Produto in: query type: string allOf: – #/definitions/productName – name: quantity description: Quantidade de tenants in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tenantQuantities properties: tenantQuantities: type: array items: type: object allOf: – #/definitions/tenantQuantity minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getTopUsage: post: description: Retorna os maiores usos por tenant conforme produto e métrica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – productName – metricName – size – offset properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string allOf: – #/definitions/topUsageMetricName description: Métrica size: type: integer format: int64 description: Tamanho da página offset: type: integer format: int64 description: Offset da página responses: 200: description: Ok schema: type: object required: – contents – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/topUsageItem minimum: 1 description: Conteúdo paginado totalElements: type: integer format: int64 description: Total sem paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os maiores usos por tenant conforme produto e métrica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: productName description: Produto in: query required: true type: string allOf: – #/definitions/productName – name: metricName description: Métrica in: query required: true type: string allOf: – #/definitions/topUsageMetricName – name: size description: Tamanho da página in: query required: true type: integer format: int64 – name: offset description: Offset da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/topUsageItem minimum: 1 description: Conteúdo paginado totalElements: type: integer format: int64 description: Total sem paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getActiveUserByProduct: post: description: Retorna a quantidade de usuários ativos no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – productName properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final productName: type: string allOf: – #/definitions/productName description: produto tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – activeUserQty properties: activeUserQty: type: integer format: int64 description: Usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de usuários ativos no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: productName description: produto in: query required: true type: string allOf: – #/definitions/productName – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – activeUserQty properties: activeUserQty: type: integer format: int64 description: Usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getTenantUsageByProduct: post: description: Retorna o uso dos tenants no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – productNames – tenants properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final productNames: type: array items: type: string allOf: – #/definitions/productName minimum: 1 description: produto tenants: type: array items: type: string minimum: 1 description: Tenant responses: 200: description: Ok schema: type: object required: – usage properties: usage: type: array items: type: object allOf: – #/definitions/productUsage minimum: 1 description: Valores de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionResume: post: description: Retorna o resumo de execuções do Connect no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – allExecutions – successExecution – errorExecution properties: allExecutions: type: number format: double description: Total de execuções successExecution: type: number format: double description: Execuções com sucesso errorExecution: type: number format: double description: Execuções com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o resumo de execuções do Connect no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – allExecutions – successExecution – errorExecution properties: allExecutions: type: number format: double description: Total de execuções successExecution: type: number format: double description: Execuções com sucesso errorExecution: type: number format: double description: Execuções com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionByStatus: post: description: Retorna as execuções do Connect agrupadas por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionStatus minimum: 1 description: Lista de execuções por status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções do Connect agrupadas por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionStatus minimum: 1 description: Lista de execuções por status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionByOrigin: post: description: Retorna as execuções do Connect agrupadas por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionByOrigin minimum: 1 description: Lista de execuções por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções do Connect agrupadas por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionByOrigin minimum: 1 description: Lista de execuções por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionMonthly: post: description: Retorna as execuções mensais do Connect nos últimos 12 meses tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionMonthly minimum: 1 description: Lista de execuções mensais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções mensais do Connect nos últimos 12 meses tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionMonthly minimum: 1 description: Lista de execuções mensais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionPerformance: post: description: Retorna métricas de performance das execuções do Connect tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – averageMs – p95Ms – maxMs properties: averageMs: type: number format: double description: Média em milissegundos p95Ms: type: number format: double description: Percentil 95 em milissegundos maxMs: type: number format: double description: Máximo em milissegundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna métricas de performance das execuções do Connect tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – averageMs – p95Ms – maxMs properties: averageMs: type: number format: double description: Média em milissegundos p95Ms: type: number format: double description: Percentil 95 em milissegundos maxMs: type: number format: double description: Máximo em milissegundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getConnectExecutionByFlow: post: description: Retorna as execuções do Connect agrupadas por fluxo e tipo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionByFlow minimum: 1 description: Lista de execuções por fluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções do Connect agrupadas por fluxo e tipo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/connectExecutionByFlow minimum: 1 description: Lista de execuções por fluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmExecutionCount: post: description: Retorna a contagem de tarefas e atividades BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – taskExecutions – activityExecutions properties: taskExecutions: type: number format: double description: Total de tarefas criadas activityExecutions: type: number format: double description: Total de atividades criadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a contagem de tarefas e atividades BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – taskExecutions – activityExecutions properties: taskExecutions: type: number format: double description: Total de tarefas criadas activityExecutions: type: number format: double description: Total de atividades criadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmExecutionByOrigin: post: description: Retorna as execuções BPM agrupadas por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant metricName: type: string description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionByOrigin minimum: 1 description: Lista de execuções por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções BPM agrupadas por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string – name: metricName description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionByOrigin minimum: 1 description: Lista de execuções por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmActiveUsers: post: description: Retorna a quantidade de usuários ativos no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant metricName: type: string description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) responses: 200: description: Ok schema: type: object required: – activeUsers properties: activeUsers: type: number format: double description: Quantidade de usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de usuários ativos no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string – name: metricName description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) in: query type: string responses: 200: description: Ok schema: type: object required: – activeUsers properties: activeUsers: type: number format: double description: Quantidade de usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmActiveUsersList: post: description: Retorna a listagem de usuários ativos no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant metricName: type: string description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/bpmActiveUser minimum: 1 description: Lista de usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem de usuários ativos no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string – name: metricName description: Nome da métrica (BPMTASKCREATED ou ACTIVITYCREATED) in: query type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/bpmActiveUser minimum: 1 description: Lista de usuários ativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmExecutionMonthly: post: description: Retorna as execuções mensais do BPM nos últimos 12 meses tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionMonthly minimum: 1 description: Lista de execuções mensais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções mensais do BPM nos últimos 12 meses tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionMonthly minimum: 1 description: Lista de execuções mensais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmTaskPerformance: post: description: Retorna métricas de performance de tempo das tarefas BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – averageTimeMs – p95TimeMs – maxTimeMs properties: averageTimeMs: type: number format: double description: Média em milissegundos p95TimeMs: type: number format: double description: Percentil 95 em milissegundos maxTimeMs: type: number format: double description: Máximo em milissegundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna métricas de performance de tempo das tarefas BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – averageTimeMs – p95TimeMs – maxTimeMs properties: averageTimeMs: type: number format: double description: Média em milissegundos p95TimeMs: type: number format: double description: Percentil 95 em milissegundos maxTimeMs: type: number format: double description: Máximo em milissegundos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getBpmExecutionByProcess: post: description: Retorna as execuções BPM agrupadas por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionByProcess minimum: 1 description: Lista de execuções por processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as execuções BPM agrupadas por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant in: query type: string responses: 200: description: Ok schema: type: object required: – executions properties: executions: type: array items: type: object allOf: – #/definitions/bpmExecutionByProcess minimum: 1 description: Lista de execuções por processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getGedMetricsUsage: post: description: Retorna o total de armazenamento e arquivos do GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – totalStorageBytes – totalFiles properties: totalStorageBytes: type: number format: double description: Total de armazenamento em bytes totalFiles: type: number format: double description: Total de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o total de armazenamento e arquivos do GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – totalStorageBytes – totalFiles properties: totalStorageBytes: type: number format: double description: Total de armazenamento em bytes totalFiles: type: number format: double description: Total de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getGedDocumentsByOrigin: post: description: Retorna a quantidade de documentos do GED agrupados por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/gedDocumentByOrigin minimum: 1 description: Lista de documentos por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de documentos do GED agrupados por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/gedDocumentByOrigin minimum: 1 description: Lista de documentos por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getGedDocumentsByMimeType: post: description: Retorna a quantidade de documentos do GED agrupados por tipo de documento (mime type) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/gedDocumentByMimeType minimum: 1 description: Lista de documentos por tipo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de documentos do GED agrupados por tipo de documento (mime type) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/gedDocumentByMimeType minimum: 1 description: Lista de documentos por tipo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getGedStorageMonthly: post: description: Retorna o armazenamento e quantidade de documentos do GED agrupados por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/gedStorageMonthly minimum: 1 description: Lista mensal de armazenamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o armazenamento e quantidade de documentos do GED agrupados por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/gedStorageMonthly minimum: 1 description: Lista mensal de armazenamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getDocsignMetricsUsage: post: description: Retorna o total de envelopes e documentos do DocSign tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – totalEnvelopes – totalDocuments properties: totalEnvelopes: type: number format: double description: Total de envelopes totalDocuments: type: number format: double description: Total de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o total de envelopes e documentos do DocSign tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – totalEnvelopes – totalDocuments properties: totalEnvelopes: type: number format: double description: Total de envelopes totalDocuments: type: number format: double description: Total de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getDocsignEnvelopesByOrigin: post: description: Retorna a quantidade de envelopes do DocSign agrupados por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/docsignEnvelopeByOrigin minimum: 1 description: Lista de envelopes por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de envelopes do DocSign agrupados por origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/docsignEnvelopeByOrigin minimum: 1 description: Lista de envelopes por origem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getDocsignEnvelopesByAuthType: post: description: Retorna a quantidade de envelopes do DocSign agrupados por tipo de autenticação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/docsignEnvelopeByAuthType minimum: 1 description: Lista de envelopes por tipo de autenticação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de envelopes do DocSign agrupados por tipo de autenticação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/docsignEnvelopeByAuthType minimum: 1 description: Lista de envelopes por tipo de autenticação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/getDocsignEnvelopesMonthly: post: description: Retorna a quantidade de envelopes e documentos do DocSign agrupados por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final tenant: type: string description: Tenant (opcional) responses: 200: description: Ok schema: type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/docsignEnvelopeMonthly minimum: 1 description: Lista mensal de envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de envelopes e documentos do DocSign agrupados por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date – name: tenant description: Tenant (opcional) in: query type: string responses: 200: description: Ok schema: type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/docsignEnvelopeMonthly minimum: 1 description: Lista mensal de envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/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 /xplatform_owner_management/queries/exportTenantContractDetails: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportAvailableTenantView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportAvailableTenant: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportContract: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportSubject: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportContractLog: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportFeatureApproved: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportProductFeature: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportBillingDocSign: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportCost: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportTenantCost: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportActiveUser: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportMetricsUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportConnectMetricsUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportBpmMetricsUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportGedMetricsUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/queries/exportDocsignMetricsUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/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 /xplatform_owner_management/actions/addProductFeature: post: description: Obter o interesse no produto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productName – featureProduct – hasInterest – username – login – email – tenant – domain properties: productName: type: string allOf: – #/definitions/productName description: Identificação do produto featureProduct: type: string allOf: – #/definitions/featureProduct description: Identificação do recurso hasInterest: type: boolean description: Interesse username: type: string description: Nome completo do Usuário login: type: string description: Login do usuário email: type: string description: Email do usuário tenant: type: string description: Tenant domain: type: string description: Domínio responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/addBillingDocSign: post: description: Adicionar billing do produto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productName – login – domain – documentTitle – documentId – envelopeName – documentSignatureStatus properties: productName: type: string allOf: – #/definitions/productName description: Identificação do produto login: type: string description: Login do usuário domain: type: string description: Domínio documentTitle: type: string description: Nome do documento documentId: type: string description: Id do documento envelopeName: type: string description: Nome do envelope envelopeId: type: string description: Id do envelope documentSignatureStatus: type: string description: Status do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/hasActiveContractByTenant: post: description: Verifica se existem contratos ativos por user de aplicação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – kind – tenant properties: kind: type: string allOf: – #/definitions/productName description: Produto a validar tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – showTrialMessage properties: showTrialMessage: type: boolean description: Informa se deve mostrar mensagem de aceite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/addFeatureApproved: post: description: Cria uma feature a ser aprovada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – description – name – tenant properties: description: type: string description: Descrição name: type: string description: Nome tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/getProductFeatureByUser: post: description: Retorna informações sobre features associadas a um usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – product – featureProduct properties: product: type: string allOf: – #/definitions/productName description: Nome do Produto featureProduct: type: string allOf: – #/definitions/featureProduct description: Recurso do Produto responses: 200: description: Ok schema: type: object required: – features properties: features: type: object allOf: – #/definitions/productFeature description: Feature mais recente associada ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/calculeCost: post: description: Calcular custo por tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final productName: type: string allOf: – #/definitions/productName description: Produto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/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 /xplatform_owner_management/actions/importTenantContractDetails: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importAvailableTenantView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importAvailableTenant: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importContract: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importSubject: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importContractLog: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importFeatureApproved: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importProductFeature: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importBillingDocSign: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importCost: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importTenantCost: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importActiveUser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importMetricsUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importConnectMetricsUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importBpmMetricsUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importGedMetricsUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/actions/importDocsignMetricsUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/createContractBatch: post: description: Criar o contratos dos tenants existens hoje tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants – kind properties: tenants: type: array items: type: string minimum: 1 description: Tenants kind: type: string allOf: – #/definitions/productName description: Produto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/notifyTrialContract: post: description: Notifica os contratos trial tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/updateTenantsContractInfo: post: description: Atualiza as informações dos contratos dos tenants na tabela shared tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/persistMetricsUsage: post: description: Registra uma métrica de uso com origem de chamada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – productName – metricName – metricValue properties: productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica dynamicFields: type: string description: Campos dinâmicos origin: type: string description: Origem da request context: type: string description: Context tenant: type: string description: Tenant responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/persistMetricsUsageConnect: post: description: Registra uma métrica de uso com origem de chamada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – productName – metricName – metricValue properties: productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica dynamicFields: type: string description: Campos dinâmicos origin: type: string description: Origem da request context: type: string description: Context tenant: type: string description: Tenant accessToken: type: string description: Token responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/generateActiveUser: post: description: Atualiza os usuários ativos no período tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: executeDate: type: string format: date description: Data responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/refreshMetricsUsageMaterializedViews: post: description: Atualiza as materialized views de métricas em shared tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/signals/syncBillingMetricsUsage: post: description: Sincroniza com o billing o histórico de métricas de uso dos produtos tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/events/importTenantContractDetailsEvent: 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 /xplatform_owner_management/events/exportTenantContractDetailsEvent: 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 /xplatform_owner_management/events/importAvailableTenantViewEvent: 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 /xplatform_owner_management/events/exportAvailableTenantViewEvent: 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 /xplatform_owner_management/events/importAvailableTenantEvent: 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 /xplatform_owner_management/events/exportAvailableTenantEvent: 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 /xplatform_owner_management/events/importContractEvent: 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 /xplatform_owner_management/events/exportContractEvent: 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 /xplatform_owner_management/events/importSubjectEvent: 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 /xplatform_owner_management/events/exportSubjectEvent: 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 /xplatform_owner_management/events/importContractLogEvent: 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 /xplatform_owner_management/events/exportContractLogEvent: 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 /xplatform_owner_management/events/importFeatureApprovedEvent: 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 /xplatform_owner_management/events/exportFeatureApprovedEvent: 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 /xplatform_owner_management/events/importProductFeatureEvent: 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 /xplatform_owner_management/events/exportProductFeatureEvent: 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 /xplatform_owner_management/events/importBillingDocSignEvent: 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 /xplatform_owner_management/events/exportBillingDocSignEvent: 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 /xplatform_owner_management/events/importCostEvent: 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 /xplatform_owner_management/events/exportCostEvent: 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 /xplatform_owner_management/events/importTenantCostEvent: 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 /xplatform_owner_management/events/exportTenantCostEvent: 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 /xplatform_owner_management/events/importActiveUserEvent: 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 /xplatform_owner_management/events/exportActiveUserEvent: 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 /xplatform_owner_management/events/importMetricsUsageEvent: 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 /xplatform_owner_management/events/exportMetricsUsageEvent: 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 /xplatform_owner_management/events/importConnectMetricsUsageEvent: 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 /xplatform_owner_management/events/exportConnectMetricsUsageEvent: 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 /xplatform_owner_management/events/importBpmMetricsUsageEvent: 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 /xplatform_owner_management/events/exportBpmMetricsUsageEvent: 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 /xplatform_owner_management/events/importGedMetricsUsageEvent: 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 /xplatform_owner_management/events/exportGedMetricsUsageEvent: 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 /xplatform_owner_management/events/importDocsignMetricsUsageEvent: 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 /xplatform_owner_management/events/exportDocsignMetricsUsageEvent: 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 /xplatform_owner_management/entities/tenantContractDetails: 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/tenantContractDetails responses: 200: description: The created resource schema: #/definitions/tenantContractDetails 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/tenantContractDetails responses: 200: description: The created resource schema: #/definitions/tenantContractDetails 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tenantContractDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/tenantContractDetails/{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/editTenantContractDetails responses: 200: description: Ok schema: #/definitions/editTenantContractDetails 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/tenantContractDetails responses: 200: description: Ok schema: #/definitions/tenantContractDetails 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/tenantContractDetails 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 /xplatform_owner_management/entities/tenantContractDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantContractDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/availableTenantView: 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/availableTenantView responses: 200: description: The created resource schema: #/definitions/availableTenantView 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/availableTenantView responses: 200: description: The created resource schema: #/definitions/availableTenantView 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/availableTenantView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/availableTenantView/{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/editAvailableTenantView responses: 200: description: Ok schema: #/definitions/editAvailableTenantView 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/availableTenantView responses: 200: description: Ok schema: #/definitions/availableTenantView 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/availableTenantView 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 /xplatform_owner_management/entities/availableTenantView/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/availableTenantView responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/availableTenant: 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/availableTenant responses: 200: description: The created resource schema: #/definitions/availableTenant 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/availableTenant responses: 200: description: The created resource schema: #/definitions/availableTenant 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/availableTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/availableTenant/{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/editAvailableTenant responses: 200: description: Ok schema: #/definitions/editAvailableTenant 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/availableTenant responses: 200: description: Ok schema: #/definitions/availableTenant 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/availableTenant 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 /xplatform_owner_management/entities/availableTenant/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/availableTenant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/contract: 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/contract/{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/editContract responses: 200: description: Ok schema: #/definitions/editContract 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/contract responses: 200: description: Ok schema: #/definitions/contract 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/contract 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 /xplatform_owner_management/entities/contract/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/subject: 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/subject responses: 200: description: The created resource schema: #/definitions/subject 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/subject responses: 200: description: The created resource schema: #/definitions/subject 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/subject/{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/editSubject responses: 200: description: Ok schema: #/definitions/editSubject 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/subject responses: 200: description: Ok schema: #/definitions/subject 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/subject 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 /xplatform_owner_management/entities/subject/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/subject responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/contractLog: 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/contractLog responses: 200: description: The created resource schema: #/definitions/contractLog 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/contractLog responses: 200: description: The created resource schema: #/definitions/contractLog 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contractLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/contractLog/{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/editContractLog responses: 200: description: Ok schema: #/definitions/editContractLog 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/contractLog responses: 200: description: Ok schema: #/definitions/contractLog 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/contractLog 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 /xplatform_owner_management/entities/contractLog/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/featureApproved: 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/featureApproved responses: 200: description: The created resource schema: #/definitions/featureApproved 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/featureApproved responses: 200: description: The created resource schema: #/definitions/featureApproved 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/featureApproved 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/featureApproved/{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/editFeatureApproved responses: 200: description: Ok schema: #/definitions/editFeatureApproved 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/featureApproved responses: 200: description: Ok schema: #/definitions/featureApproved 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/featureApproved 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 /xplatform_owner_management/entities/featureApproved/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/featureApproved responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/productFeature: 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/productFeature responses: 200: description: The created resource schema: #/definitions/productFeature 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/productFeature responses: 200: description: The created resource schema: #/definitions/productFeature 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productFeature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/productFeature/{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/editProductFeature responses: 200: description: Ok schema: #/definitions/editProductFeature 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/productFeature responses: 200: description: Ok schema: #/definitions/productFeature 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/productFeature 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 /xplatform_owner_management/entities/productFeature/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/productFeature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/billingDocSign: 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/billingDocSign responses: 200: description: The created resource schema: #/definitions/billingDocSign 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/billingDocSign responses: 200: description: The created resource schema: #/definitions/billingDocSign 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/billingDocSign 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/billingDocSign/{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/editBillingDocSign responses: 200: description: Ok schema: #/definitions/editBillingDocSign 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/billingDocSign responses: 200: description: Ok schema: #/definitions/billingDocSign 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/billingDocSign 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 /xplatform_owner_management/entities/billingDocSign/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/billingDocSign responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/cost: 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/cost responses: 200: description: The created resource schema: #/definitions/cost 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/cost responses: 200: description: The created resource schema: #/definitions/cost 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cost 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/cost/{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/editCost responses: 200: description: Ok schema: #/definitions/editCost 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/cost responses: 200: description: Ok schema: #/definitions/cost 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/cost 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 /xplatform_owner_management/entities/cost/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cost responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/tenantCost: 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/tenantCost responses: 200: description: The created resource schema: #/definitions/tenantCost 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/tenantCost responses: 200: description: The created resource schema: #/definitions/tenantCost 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tenantCost 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/tenantCost/{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/editTenantCost responses: 200: description: Ok schema: #/definitions/editTenantCost 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/tenantCost responses: 200: description: Ok schema: #/definitions/tenantCost 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/tenantCost 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 /xplatform_owner_management/entities/tenantCost/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantCost responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/activeUser: 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/activeUser responses: 200: description: The created resource schema: #/definitions/activeUser 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/activeUser responses: 200: description: The created resource schema: #/definitions/activeUser 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/activeUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/activeUser/{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/editActiveUser responses: 200: description: Ok schema: #/definitions/editActiveUser 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/activeUser responses: 200: description: Ok schema: #/definitions/activeUser 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/activeUser 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 /xplatform_owner_management/entities/activeUser/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activeUser responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/metricsUsage: 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/metricsUsage responses: 200: description: The created resource schema: #/definitions/metricsUsage 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/metricsUsage responses: 200: description: The created resource schema: #/definitions/metricsUsage 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/metricsUsage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/metricsUsage/{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/editMetricsUsage responses: 200: description: Ok schema: #/definitions/editMetricsUsage 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/metricsUsage responses: 200: description: Ok schema: #/definitions/metricsUsage 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/metricsUsage 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 /xplatform_owner_management/entities/metricsUsage/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/metricsUsage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/connectMetricsUsage: 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/connectMetricsUsage responses: 200: description: The created resource schema: #/definitions/connectMetricsUsage 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/connectMetricsUsage responses: 200: description: The created resource schema: #/definitions/connectMetricsUsage 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/connectMetricsUsage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/connectMetricsUsage/{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/editConnectMetricsUsage responses: 200: description: Ok schema: #/definitions/editConnectMetricsUsage 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/connectMetricsUsage responses: 200: description: Ok schema: #/definitions/connectMetricsUsage 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/connectMetricsUsage 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 /xplatform_owner_management/entities/connectMetricsUsage/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/connectMetricsUsage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/bpmMetricsUsage: 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/bpmMetricsUsage responses: 200: description: The created resource schema: #/definitions/bpmMetricsUsage 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/bpmMetricsUsage responses: 200: description: The created resource schema: #/definitions/bpmMetricsUsage 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/bpmMetricsUsage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/bpmMetricsUsage/{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/editBpmMetricsUsage responses: 200: description: Ok schema: #/definitions/editBpmMetricsUsage 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/bpmMetricsUsage responses: 200: description: Ok schema: #/definitions/bpmMetricsUsage 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/bpmMetricsUsage 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 /xplatform_owner_management/entities/bpmMetricsUsage/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bpmMetricsUsage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/gedMetricsUsage: 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/gedMetricsUsage responses: 200: description: The created resource schema: #/definitions/gedMetricsUsage 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/gedMetricsUsage responses: 200: description: The created resource schema: #/definitions/gedMetricsUsage 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/gedMetricsUsage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/gedMetricsUsage/{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/editGedMetricsUsage responses: 200: description: Ok schema: #/definitions/editGedMetricsUsage 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/gedMetricsUsage responses: 200: description: Ok schema: #/definitions/gedMetricsUsage 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/gedMetricsUsage 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 /xplatform_owner_management/entities/gedMetricsUsage/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/gedMetricsUsage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/docsignMetricsUsage: 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/docsignMetricsUsage responses: 200: description: The created resource schema: #/definitions/docsignMetricsUsage 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/docsignMetricsUsage responses: 200: description: The created resource schema: #/definitions/docsignMetricsUsage 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/docsignMetricsUsage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xplatform_owner_management/entities/docsignMetricsUsage/{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/editDocsignMetricsUsage responses: 200: description: Ok schema: #/definitions/editDocsignMetricsUsage 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/docsignMetricsUsage responses: 200: description: Ok schema: #/definitions/docsignMetricsUsage 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/docsignMetricsUsage 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 /xplatform_owner_management/entities/docsignMetricsUsage/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/docsignMetricsUsage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down productName: type: string enum: – BPM – GED – BOT – SIGN – CONNECT – SHARED description: Tipos de produto: * `BPM` – BPM * `GED` – GED * `BOT` – BOT * `SIGN` – SIGN * `CONNECT` – Connect * `SHARED` – Shared topUsageMetricName: type: string enum: – ACTIVITYCREATED – BPMTASKCREATED – GEDKBCREATED – DOCSIGNCREATED – EXECUTION description: Métricas aceitas para top usage: * `ACTIVITYCREATED` – Atividades criadas no BPM * `BPMTASKCREATED` – Tarefas criadas no BPM * `GEDKBCREATED` – KB criados no GED * `DOCSIGNCREATED` – Documentos criados no Sign * `EXECUTION` – Execuções do Connect contractTime: type: string enum: – TRIAL – INFINITY description: Tipo de contrato: * `TRIAL` – Contrato de 30 dias * `INFINITY` – Contrato sem vencimento productTypeFilter: type: string enum: – BPM – GED_SIGN – CONNECT – MISC description: Tipo de produtos filtrados: * `BPM` – BPM * `GED_SIGN` – GED / SIGN * `CONNECT` – CONNECT * `MISC` – Miscelânea featureProduct: type: string enum: – INBOX – TOUR_START – TOUR_ENVELOPE_MANAGEMENT description: Tipo do recurso dos produtos: * `INBOX` – SIGN – Caixa de entrada * `TOUR_START` – GED – Tour * `TOUR_ENVELOPE_MANAGEMENT` – SIGN – Tour Gestão Envelope userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_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 productUsage: description: type: object required: – productName – metricName – tenant – quantity properties: productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Meritrica tenant: type: string description: Tenant quantity: type: number format: double description: Quantidade de uso tenantQuantity: description: type: object required: – tenantName – quantity properties: tenantName: type: string description: tenant quantity: type: integer format: int64 description: Quantidade topUsageItem: description: type: object required: – tenant – productName – metricName – metricValue properties: tenant: type: string description: Tenant productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Soma da métrica no período connectExecutionStatus: description: Execução agrupada por status type: object required: – label – value properties: label: type: string description: Status label value: type: number format: double description: Total value connectExecutionByOrigin: description: Execução agrupada por origem type: object required: – label – value properties: label: type: string description: Origin value: type: number format: double description: Total value connectExecutionMonthly: description: Execução mensal com sucesso e erro type: object required: – month – success – errorValue properties: month: type: string description: Month (MM/YYYY) success: type: number format: double description: Total successful executions errorValue: type: number format: double description: Total error executions connectExecutionByFlow: description: Execução agrupada por fluxo e tipo type: object required: – flow – type – executions – successPercentage properties: flow: type: string description: Integration identifier (flow name) type: type: string description: Origin type executions: type: number format: double description: Total executions successPercentage: type: number format: double description: Success percentage bpmExecutionByOrigin: description: Execução BPM agrupada por origem type: object required: – label – value properties: label: type: string description: Origin label value: type: number format: double description: Total count bpmActiveUser: description: Usuário ativo BPM type: object required: – name – email properties: name: type: string description: User name email: type: string description: User email bpmExecutionMonthly: description: Execução mensal BPM com tarefas e atividades type: object required: – month – taskCount – activityCount properties: month: type: string description: Month (MM/YYYY) taskCount: type: number format: double description: Total task executions activityCount: type: number format: double description: Total activity executions bpmExecutionByProcess: description: Execução BPM agrupada por processo type: object required: – flow – tasks – activities – icon properties: flow: type: string description: Process name tasks: type: number format: double description: Total tasks activities: type: number format: double description: Total activities icon: type: string description: Process icon gedDocumentByOrigin: description: Documento GED agrupado por origem type: object required: – label – value properties: label: type: string description: Origem (API, FRONTEND, HCM, ERP, OUTROS) value: type: number format: double description: Total de documentos gedDocumentByMimeType: description: Documento GED agrupado por tipo (mime type) type: object required: – mimeType – totalDocuments properties: mimeType: type: string description: Tipo do documento (mime type) totalDocuments: type: number format: double description: Total de documentos gedStorageMonthly: description: Armazenamento mensal do GED type: object required: – month – totalStorageBytes – totalDocuments properties: month: type: string description: Mês (YYYY-MM) totalStorageBytes: type: number format: double description: Total de armazenamento em bytes totalDocuments: type: number format: double description: Total de documentos docsignEnvelopeByOrigin: description: Envelope DocSign agrupado por origem type: object required: – label – value properties: label: type: string description: Origem value: type: number format: double description: Total de envelopes docsignEnvelopeByAuthType: description: Envelope DocSign agrupado por tipo de autenticação type: object required: – label – value properties: label: type: string description: Tipo de autenticação value: type: number format: double description: Total de envelopes docsignEnvelopeMonthly: description: Envelopes e documentos DocSign agrupados por mês type: object required: – month – totalEnvelopes – totalDocuments properties: month: type: string description: Mês (MM/YYYY) totalEnvelopes: type: number format: double description: Total de envelopes totalDocuments: type: number format: double description: Total de documentos tenantContractDetails: description: Detalhes dos contratos e clientes ERP type: object required: – product – tenantName – erpCode – companyName – cnpj – phoneNumber – contractCode – contractDescription – contractLimit – segment properties: id: type: string format: uuid description: Identificador product: type: string description: Produto do contrato tenantName: type: string description: Nome do tenant erpCode: type: integer format: int64 description: Código do ERP companyName: type: string description: Razão Social cnpj: type: string description: CNPJ do cliente phoneNumber: type: string description: Contato do cliente contractCode: type: integer format: int64 description: Código do contrato contractDescription: type: string description: Descrição do contrato contractLimit: type: integer format: int64 description: Limite do contrato segment: type: string description: Segmento do contrato contractId: type: string format: uuid description: Id do contrato license service createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTenantContractDetails: type: object required: – id allOf: – #/definitions/tenantContractDetails availableTenantView: description: View dos tenants disponíveis para contrato type: object required: – name – tenant – kind – contractTime properties: id: type: string format: uuid description: Identificador tenantId: type: string format: uuid description: Identificador do tenant name: type: string description: Nome do tenant tenant: type: string description: Nome do schema erpCode: type: string description: Código ERP kind: type: string allOf: – #/definitions/productName description: Produto contractTime: type: string allOf: – #/definitions/contractTime description: Tempo de contrato notify: type: boolean description: Notificar vencimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAvailableTenantView: type: object required: – id allOf: – #/definitions/availableTenantView availableTenant: description: Tenants disponíveis para contrato type: object required: – name – tenant properties: id: type: string format: uuid description: Identificador name: type: string description: Nome do tenant tenant: type: string description: Nome do schema erpCode: type: string description: Código ERP notify: type: boolean description: Notificar vencimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAvailableTenant: type: object required: – id allOf: – #/definitions/availableTenant contract: description: Contratos do tenant type: object required: – tenant – kind – contractTime – startDate properties: id: type: string format: uuid description: Identificador tenant: type: string format: uuid description: Tenant do contrato kind: type: string allOf: – #/definitions/productName description: Produto contractTime: type: string allOf: – #/definitions/contractTime description: Tempo de contrato startDate: type: string format: date-time description: Vencimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContract: type: object required: – id allOf: – #/definitions/contract subject: description: Usuários a noticar do tenant type: object required: – tenantId – email – name – username properties: id: type: string format: uuid description: Identificador tenantId: type: string format: uuid description: Tenant do contrato email: type: string description: E-Mail name: type: string description: Nome username: type: string description: Nome de usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSubject: type: object required: – id allOf: – #/definitions/subject contractLog: description: Log de contratos type: object required: – contractId – details properties: id: type: string format: uuid description: Identificador contractId: type: string format: uuid description: Identificador do contrato details: type: string description: Detalhes createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractLog: type: object required: – id allOf: – #/definitions/contractLog featureApproved: description: Feature Aprovadas type: object required: – description – name – tenant – approved properties: id: type: string format: uuid description: Identificador description: type: string description: Descrição name: type: string description: Nome tenant: type: string description: Tenant approved: type: boolean description: Aprovado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFeatureApproved: type: object required: – id allOf: – #/definitions/featureApproved productFeature: description: Entidade que contém o engajamento do produto type: object required: – username – login – tenant – email – domain – product – featureProduct – hasInterest properties: id: type: string format: uuid description: Identificação username: type: string description: Nome do Usuário login: type: string description: Login do Usuário tenant: type: string description: Tenant do Usuário email: type: string description: Email do Usuário domain: type: string description: Domínio do Usuário product: type: string allOf: – #/definitions/productName description: Nome do Produto featureProduct: type: string allOf: – #/definitions/featureProduct description: Recurso do Produto hasInterest: type: boolean description: Usuário tem Interesse no Recurso createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProductFeature: type: object required: – id allOf: – #/definitions/productFeature billingDocSign: description: Entidade que contém o billing do ged type: object required: – login – domain – productName – documentTitle – documentId – envelopeName – documentSignatureStatus properties: id: type: string format: uuid description: Identificação login: type: string description: Login do Usuário domain: type: string description: Domínio do Usuário productName: type: string allOf: – #/definitions/productName description: Nome do Produto documentTitle: type: string description: Nome do documento documentId: type: string format: uuid description: Id do documento envelopeName: type: string description: Nome do envelope envelopeId: type: string format: uuid description: Id do envelope documentSignatureStatus: type: string description: Status do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBillingDocSign: type: object required: – id allOf: – #/definitions/billingDocSign cost: description: Custo por produto type: object required: – productName – cost – costMonth properties: id: type: string format: uuid description: Identificação productName: type: string allOf: – #/definitions/productName description: Produto cost: type: number format: double description: Custo da infraestrutura costMonth: type: string format: date description: Mês do custo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCost: type: object required: – id allOf: – #/definitions/cost tenantCost: description: Custo por tenant type: object required: – tenant – productName – quantity – storage – unitCost – costMonth properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant productName: type: string allOf: – #/definitions/productName description: Produto quantity: type: integer format: int64 description: Quantidade do custo storage: type: number format: double description: Storage do tenant unitCost: type: number format: double description: Unidade de custo costMonth: type: string format: date description: Mês do custo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTenantCost: type: object required: – id allOf: – #/definitions/tenantCost activeUser: description: type: object required: – tenant – productName – userMonth – username properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant productName: type: string allOf: – #/definitions/productName description: Produto userMonth: type: string format: date description: Mês do custo username: type: string description: Usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editActiveUser: type: object required: – id allOf: – #/definitions/activeUser metricsUsage: description: Entidade que contém as métricas de uso dos produtos type: object required: – tenant – username – productName – metricName – metricValue – origin – ip – isFinalized properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant username: type: string description: Usuário productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica origin: type: string description: Origem da métrica ip: type: string description: Ip dynamicFields: type: string description: Campos dinâmicos isFinalized: type: boolean description: Finalizado context: type: string description: Context createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMetricsUsage: type: object required: – id allOf: – #/definitions/metricsUsage connectMetricsUsage: description: Entidade com métricas de execução do Connect type: object required: – tenant – username – productName – metricName – metricValue – origin – ip – isFinalized – status properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant username: type: string description: Usuário productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica origin: type: string description: Origem da métrica ip: type: string description: Ip isFinalized: type: boolean description: Finalizado context: type: string description: Context status: type: string description: Status da execução integrationIdentifier: type: string description: Identificador da integração startedAt: type: string format: date-time description: Início da execução endedAt: type: string format: date-time description: Fim da execução durationMs: type: integer format: int64 description: Duração em milissegundos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConnectMetricsUsage: type: object required: – id allOf: – #/definitions/connectMetricsUsage bpmMetricsUsage: description: Entidade com métricas de uso do BPM type: object required: – tenant – username – productName – metricName – metricValue – origin – ip – isFinalized properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant username: type: string description: Usuário productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica origin: type: string description: Origem da métrica ip: type: string description: Ip isFinalized: type: boolean description: Finalizado context: type: string description: Context processName: type: string description: Nome do processo taskTime: type: string description: Tempo da tarefa dynamicUsername: type: string description: Usuário do dynamic_fields iconProcess: type: string description: Ícone do processo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBpmMetricsUsage: type: object required: – id allOf: – #/definitions/bpmMetricsUsage gedMetricsUsage: description: Entidade com métricas de uso do GED (materialized view gedkbc_metrics_usage) type: object properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant username: type: string description: Usuário productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: string description: Valor da métrica origin: type: string description: Origem da métrica ip: type: string description: Ip isFinalized: type: boolean description: Finalizado context: type: string description: Context dynamicFieldsJson: type: string description: Dynamic fields em JSON createdByDynamic: type: string description: Criado por (dynamic fields) author: type: string description: Autor documentVersionId: type: string description: ID da versão do documento mimeType: type: string description: Mime type isBatch: type: string description: É lote documentTitle: type: string description: Título do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editGedMetricsUsage: type: object required: – id allOf: – #/definitions/gedMetricsUsage docsignMetricsUsage: description: Entidade com métricas de uso do DocSign (materialized view docsign_metrics_usage) type: object properties: id: type: string format: uuid description: Identificação tenant: type: string description: Tenant username: type: string description: Usuário productName: type: string allOf: – #/definitions/productName description: Produto metricName: type: string description: Métrica metricValue: type: number format: double description: Valor da métrica origin: type: string description: Origem da métrica ip: type: string description: Ip isFinalized: type: boolean description: Finalizado context: type: string description: Context dynamicFieldsJson: type: string description: Dynamic fields em JSON signatureDate: type: string description: Data da assinatura envelopeId: type: string description: ID do envelope numberOfDocuments: type: integer format: int64 description: Quantidade de documentos numberOfSignatures: type: integer format: int64 description: Quantidade de assinaturas signerNames: type: string description: Nomes dos signatários authenticationTypes: type: string description: Tipos de autenticação dos signatários documentVersionIds: type: string description: IDs das versões dos documentos createdBySign: type: string description: Criado por createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocsignMetricsUsage: type: object required: – id allOf: – #/definitions/docsignMetricsUsage 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage