2.0info: 4.7.0 approval_service x-senior-domain: tic_arq x-senior-domain-path: tic_arq x-senior-service-path: approval_service 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/tic_arqsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /approval_service/queries/getApprovalPolicyStructure: post: description: Returns a full approval policy structure in one payload for policy edition screens. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – policyId properties: policyId: type: string description: Policy identifier (UUID as string) responses: 200: description: Ok schema: type: object required: – structureJson properties: structureJson: type: string description: JSON object containing policy, fields, flowSteps, ruleBlocks, ruleConditions and requirements 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a full approval policy structure in one payload for policy edition screens. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: policyId description: Policy identifier (UUID as string) in: query required: true type: string responses: 200: description: Ok schema: type: object required: – structureJson properties: structureJson: type: string description: JSON object containing policy, fields, flowSteps, ruleBlocks, ruleConditions and requirements 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/consultDa080Approval: post: description: Consults the DA080 approval level using the CRM-facing payload. This endpoint does not persist data. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – system – approvalKey – data properties: system: type: string maxLength: 40 description: Caller system, for example crm approvalKey: type: string maxLength: 80 description: Approval business key, for example orders data: type: object allOf: – #/definitions/da080ApprovalRequestData description: CRM DA080 payload responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/da080ApprovalConsultOutput description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/getDa080ApprovalRequestStatus: post: description: Returns a persisted DA080 approval request with async hierarchy job and resolved HCM/channel approvers. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: requestId: type: string description: Stored DA080 request identifier. If omitted, proposalNumber is used. proposalNumber: type: string description: Proposal number used to find the latest DA080 request when requestId is omitted. proposalId: type: string description: CRM proposal identifier used together with proposalNumber. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/da080ApprovalRequestStatusOutput description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a persisted DA080 approval request with async hierarchy job and resolved HCM/channel approvers. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: requestId description: Stored DA080 request identifier. If omitted, proposalNumber is used. in: query type: string – name: proposalNumber description: Proposal number used to find the latest DA080 request when requestId is omitted. in: query type: string – name: proposalId description: CRM proposal identifier used together with proposalNumber. in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/da080ApprovalRequestStatusOutput description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/listDa080ApprovalRequestStatus: post: description: Lists persisted DA080 approval requests with workflow status data for approval queue screens. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: requestStatus: type: string maxLength: 30 description: Optional request status filter. offset: type: integer format: int64 description: Zero-based row offset. default: 0 size: type: integer format: int64 description: Maximum number of requests returned. default: 100 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listDa080ApprovalRequestStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists persisted DA080 approval requests with workflow status data for approval queue screens. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: requestStatus description: Optional request status filter. in: query type: string maxLength: 30 – name: offset description: Zero-based row offset. in: query type: integer format: int64 – name: size description: Maximum number of requests returned. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listDa080ApprovalRequestStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/listAuditTrail: post: description: Lists immutable audit log entries generated by approval_service operations. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: actorUserId: type: string maxLength: 150 description: Filter by actor user login or email. endpoint: type: string maxLength: 160 description: Filter by endpoint or handler name. operation: type: string maxLength: 80 description: Filter by business operation name. entityName: type: string maxLength: 120 description: Filter by affected resource/entity name. entityId: type: string maxLength: 120 description: Filter by affected resource/entity identifier. requestId: type: string maxLength: 36 description: Filter by DA080 request identifier. proposalNumber: type: string maxLength: 80 description: Filter by proposal number. correlationId: type: string maxLength: 120 description: Filter by correlation/request id. status: type: string maxLength: 20 description: Filter by execution status: SUCCESS | ERROR. eventTimeFrom: type: string format: date-time description: Filter events created at or after this timestamp. eventTimeTo: type: string format: date-time description: Filter events created at or before this timestamp. offset: type: integer format: int64 description: Zero-based row offset. default: 0 size: type: integer format: int64 description: Maximum number of logs returned. default: 100 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listAuditLogOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists immutable audit log entries generated by approval_service operations. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: actorUserId description: Filter by actor user login or email. in: query type: string maxLength: 150 – name: endpoint description: Filter by endpoint or handler name. in: query type: string maxLength: 160 – name: operation description: Filter by business operation name. in: query type: string maxLength: 80 – name: entityName description: Filter by affected resource/entity name. in: query type: string maxLength: 120 – name: entityId description: Filter by affected resource/entity identifier. in: query type: string maxLength: 120 – name: requestId description: Filter by DA080 request identifier. in: query type: string maxLength: 36 – name: proposalNumber description: Filter by proposal number. in: query type: string maxLength: 80 – name: correlationId description: Filter by correlation/request id. in: query type: string maxLength: 120 – name: status description: Filter by execution status: SUCCESS | ERROR. in: query type: string maxLength: 20 – name: eventTimeFrom description: Filter events created at or after this timestamp. in: query type: string format: date-time – name: eventTimeTo description: Filter events created at or before this timestamp. in: query type: string format: date-time – name: offset description: Zero-based row offset. in: query type: integer format: int64 – name: size description: Maximum number of logs returned. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listAuditLogOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/listHcmUser: post: description: Lists users available for approval substitutions. A full corporate e-mail is also looked up in the HCM, so people who never signed in to Approval can be found. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string maxLength: 150 description: Optional text filter applied to username, name and email; a full e-mail is also looked up in the HCM activeOnly: type: boolean description: When true, returns only active users default: true offset: type: integer format: int64 description: Zero-based row offset default: 0 size: type: integer format: int64 description: Maximum number of users returned default: 50 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listHcmUserOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists users available for approval substitutions. A full corporate e-mail is also looked up in the HCM, so people who never signed in to Approval can be found. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Optional text filter applied to username, name and email; a full e-mail is also looked up in the HCM in: query type: string maxLength: 150 – name: activeOnly description: When true, returns only active users in: query type: boolean – name: offset description: Zero-based row offset in: query type: integer format: int64 – name: size description: Maximum number of users returned in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listHcmUserOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/queries/listApprovalAccessUsers: post: description: Lists platform users with their current approval access role. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string maxLength: 150 description: Optional text filter applied to username, name and email activeOnly: type: boolean description: When true, returns only active users default: true roleCode: type: string maxLength: 80 description: Optional active role filter offset: type: integer format: int64 description: Zero-based row offset default: 0 size: type: integer format: int64 description: Maximum number of users returned default: 50 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listApprovalAccessUsersOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists platform users with their current approval access role. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Optional text filter applied to username, name and email in: query type: string maxLength: 150 – name: activeOnly description: When true, returns only active users in: query type: boolean – name: roleCode description: Optional active role filter in: query type: string maxLength: 80 – name: offset description: Zero-based row offset in: query type: integer format: int64 – name: size description: Maximum number of users returned in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listApprovalAccessUsersOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/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 /approval_service/queries/exportApprovalScope: 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 /approval_service/queries/exportApprovalChannel: 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 /approval_service/queries/exportPolicyScenario: 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 /approval_service/queries/exportScopeLevel: 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 /approval_service/queries/exportScopeLevelRole: 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 /approval_service/queries/exportDynamicFieldCatalog: 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 /approval_service/queries/exportApprovalPolicy: 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 /approval_service/queries/exportPolicyField: 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 /approval_service/queries/exportPolicyFlowStep: 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 /approval_service/queries/exportPolicyStepCondition: 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 /approval_service/queries/exportPolicyRuleBlock: 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 /approval_service/queries/exportPolicyRuleCondition: 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 /approval_service/queries/exportPolicyApprovalRequirement: 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 /approval_service/queries/exportDa080ApprovalRequest: 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 /approval_service/queries/exportAuditLog: 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 /approval_service/queries/exportUserAccount: 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 /approval_service/queries/exportAccessRole: 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 /approval_service/queries/exportAccessPermission: 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 /approval_service/queries/exportAccessRolePermission: 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 /approval_service/queries/exportUserAccountRole: 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 /approval_service/queries/exportUserSubstitution: 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 /approval_service/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 /approval_service/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/inactivateApprovalScope: post: description: Inactivates an approval scope (soft delete) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – scopeId properties: scopeId: type: string description: Scope identifier (UUID as string) responses: 200: description: Ok schema: type: object allOf: – #/definitions/approvalScopeStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/activateApprovalScope: post: description: Activates an approval scope tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – scopeId properties: scopeId: type: string description: Scope identifier (UUID as string) responses: 200: description: Ok schema: type: object allOf: – #/definitions/approvalScopeStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/publishApprovalPolicy: post: description: Publishes a DRAFT policy version. Fails when another ACTIVE policy exists for the same scopeId+rootCode. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – policyId properties: policyId: type: string description: Policy identifier (UUID as string) responses: 200: description: Ok schema: type: object allOf: – #/definitions/approvalPolicyStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/inactivateApprovalPolicy: post: description: Inactivates an ACTIVE policy version (no replacement). tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – policyId properties: policyId: type: string description: Policy identifier (UUID as string) responses: 200: description: Ok schema: type: object allOf: – #/definitions/approvalPolicyStatusOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/cloneApprovalPolicy: post: description: Clones an existing policy creating a new DRAFT version with version = max(version)+1. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – policyId properties: policyId: type: string description: Policy identifier to be cloned (UUID as string) responses: 200: description: Ok schema: type: object allOf: – #/definitions/approvalPolicyCloneOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/saveApprovalPolicyStructure: post: description: Persists a full DRAFT approval policy structure: policy, fields, flow, rule blocks and conditions. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – scopeId – rootCode – name – fields – flowSteps – ruleBlocks – requirements properties: policyId: type: string description: Policy identifier when updating an existing DRAFT policy scopeId: type: string description: Parent approval scope identifier scenarioId: type: string description: Scenario identifier when the policy is scoped to one DA080 scenario rootCode: type: string description: Business root code name: type: string description: Display name description: type: string description: Description effectiveFrom: type: string format: date description: Effective from (ISO date) effectiveTo: type: string format: date description: Effective to (ISO date) fields: type: array items: type: object allOf: – #/definitions/savePolicyFieldInput minimum: 1 description: Fields bound to the policy flowSteps: type: array items: type: object allOf: – #/definitions/savePolicyFlowStepInput minimum: 1 description: Approval flow steps ruleBlocks: type: array items: type: object allOf: – #/definitions/savePolicyRuleBlockInput minimum: 1 description: Rule blocks used by the simulation engine requirements: type: array items: type: object allOf: – #/definitions/savePolicyApprovalRequirementInput minimum: 1 description: Additional approval requirements, channels and fallbacks responses: 200: description: Ok schema: type: object allOf: – #/definitions/saveApprovalPolicyStructureOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/simulateApproval: post: description: Simulates an approval evaluation for a proposal payload using rule blocks and conditions. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – scopeId – rootCode – proposalNumber – items properties: scopeId: type: string description: Scope identifier (UUID as string) scenarioId: type: string description: Scenario identifier when the active policy is scoped to one DA080 scenario scenarioCode: type: string description: Scenario code when the caller does not have scenarioId rootCode: type: string description: Root code (business key) within the scope proposalNumber: type: string description: Proposal number items: type: array items: type: object allOf: – #/definitions/simulationProposalItem minimum: 1 description: Proposal item list to evaluate against the active policy responses: 200: description: Ok schema: type: object allOf: – #/definitions/simulationResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/saveDa080ApprovalRequest: post: description: Persists a DA080 approval request and prepares the local approval workflow. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – system – approvalKey – data properties: system: type: string maxLength: 40 description: Caller system, for example crm approvalKey: type: string maxLength: 80 description: Approval business key, for example orders data: type: object allOf: – #/definitions/da080ApprovalRequestData description: CRM DA080 payload responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalRequestOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/approveDa080ApprovalRequest: post: description: Approves the current or informed DA080 approval step and advances the local workflow. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Stored DA080 request identifier. stepOrder: type: integer format: int64 description: Approval step order. When omitted, the current pending step is used. comment: type: string maxLength: 500 description: Optional approval comment stored in the audit history. responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalWorkflowOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/rejectDa080ApprovalRequest: post: description: Rejects the current or informed DA080 approval step and finishes the local workflow as rejected. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Stored DA080 request identifier. stepOrder: type: integer format: int64 description: Approval step order. When omitted, the current pending step is used. rejectionReason: type: string maxLength: 500 description: Business rejection reason stored in the audit history. responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalWorkflowOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/approveDa080ApprovalRequestFromBpm: post: description: Receives a BPM approval callback and advances the DA080 local workflow. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: requestId: type: string maxLength: 36 description: Stored DA080 request identifier. idSolicitacao: type: string maxLength: 36 description: Legacy BPM request identifier field. id_solicitacao: type: string maxLength: 36 description: Legacy BPM request identifier field as sent by old Connect flows. processInstanceId: type: string maxLength: 150 description: Platform BPM process instance identifier. processInstanceID: type: string maxLength: 150 description: Platform BPM process instance identifier using the Platform response spelling. approverUserId: type: string maxLength: 150 description: Approver user login returned by BPM. approverUserName: type: string maxLength: 200 description: Approver display name returned by BPM. nome_usuario: type: string maxLength: 200 description: Legacy BPM approver field as sent by old Connect flows. comment: type: string maxLength: 500 description: Optional approval comment returned by BPM. responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalWorkflowOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/rejectDa080ApprovalRequestFromBpm: post: description: Receives a BPM rejection callback and rejects the DA080 local workflow. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: requestId: type: string maxLength: 36 description: Stored DA080 request identifier. idSolicitacao: type: string maxLength: 36 description: Legacy BPM request identifier field. id_solicitacao: type: string maxLength: 36 description: Legacy BPM request identifier field as sent by old Connect flows. processInstanceId: type: string maxLength: 150 description: Platform BPM process instance identifier. processInstanceID: type: string maxLength: 150 description: Platform BPM process instance identifier using the Platform response spelling. approverUserId: type: string maxLength: 150 description: Approver user login returned by BPM. approverUserName: type: string maxLength: 200 description: Approver display name returned by BPM. nome_usuario: type: string maxLength: 200 description: Legacy BPM approver field as sent by old Connect flows. rejectionReason: type: string maxLength: 500 description: Business rejection reason returned by BPM. responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalWorkflowOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/changeDa080ApprovalApprover: post: description: Changes the approver assigned to a pending DA080 approval step. Requires administrator permission. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – requestId – stepOrder – newApproverUserId properties: requestId: type: string description: Stored DA080 request identifier. stepOrder: type: integer format: int64 description: Approval step order that will receive another approver. newApproverUserId: type: string maxLength: 150 description: New approver user login. newApproverUserName: type: string maxLength: 200 description: New approver display name. newApproverUserEmail: type: string maxLength: 200 description: New approver email. reason: type: string maxLength: 500 description: Business reason for the approver change. responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalWorkflowOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/cancelDa080ApprovalRequest: post: description: Cancels a persisted DA080 approval request in the local approval workflow. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – system – approvalKey – proposalNumber properties: system: type: string maxLength: 40 description: Caller system, for example crm approvalKey: type: string maxLength: 80 description: Approval business key, for example orders requestId: type: string description: Stored DA080 request identifier. If omitted, the latest request for proposalNumber/proposalId is used. proposalNumber: type: string description: Proposal number proposalId: type: string description: CRM proposal identifier cancellationReason: type: string description: Business cancellation reason canceledByUserId: type: string maxLength: 150 description: Login of the user who canceled in the caller system (shown in the approval history) canceledByUserName: type: string maxLength: 200 description: Name of the user who canceled in the caller system (shown in the approval history) responses: 200: description: Ok schema: type: object allOf: – #/definitions/da080ApprovalCancelOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/changeApprovalAccessUserRole: post: description: Changes the active approval role of one platform user. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – userId – roleCode properties: userId: type: string description: User account identifier roleCode: type: string maxLength: 80 description: Approval role code: APPROVAL_VIEWER, APPROVAL_USER or APPROVAL_ADMIN reason: type: string maxLength: 500 description: Business reason for the role change responses: 200: description: Ok schema: type: object allOf: – #/definitions/changeApprovalAccessUserRoleOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/actions/getSystemAccessToken: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: accessToken: type: string description: default: responses: 200: description: Ok schema: type: object required: – saraAccess – loginUser properties: saraAccess: type: object allOf: – #/definitions/recAccess description: loginUser: type: object allOf: – #/definitions/loginUserInformation description: default: description: Error response schema: #/definitions/genericError /approval_service/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 /approval_service/actions/importApprovalScope: 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 /approval_service/actions/importApprovalChannel: 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 /approval_service/actions/importPolicyScenario: 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 /approval_service/actions/importScopeLevel: 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 /approval_service/actions/importScopeLevelRole: 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 /approval_service/actions/importDynamicFieldCatalog: 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 /approval_service/actions/importApprovalPolicy: 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 /approval_service/actions/importPolicyField: 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 /approval_service/actions/importPolicyFlowStep: 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 /approval_service/actions/importPolicyStepCondition: 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 /approval_service/actions/importPolicyRuleBlock: 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 /approval_service/actions/importPolicyRuleCondition: 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 /approval_service/actions/importPolicyApprovalRequirement: 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 /approval_service/actions/importDa080ApprovalRequest: 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 /approval_service/actions/importAuditLog: 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 /approval_service/actions/importUserAccount: 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 /approval_service/actions/importAccessRole: 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 /approval_service/actions/importAccessPermission: 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 /approval_service/actions/importAccessRolePermission: 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 /approval_service/actions/importUserAccountRole: 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 /approval_service/actions/importUserSubstitution: 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 /approval_service/events/importApprovalScopeEvent: 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 /approval_service/events/exportApprovalScopeEvent: 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 /approval_service/events/importApprovalChannelEvent: 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 /approval_service/events/exportApprovalChannelEvent: 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 /approval_service/events/importPolicyScenarioEvent: 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 /approval_service/events/exportPolicyScenarioEvent: 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 /approval_service/events/importScopeLevelEvent: 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 /approval_service/events/exportScopeLevelEvent: 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 /approval_service/events/importScopeLevelRoleEvent: 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 /approval_service/events/exportScopeLevelRoleEvent: 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 /approval_service/events/importDynamicFieldCatalogEvent: 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 /approval_service/events/exportDynamicFieldCatalogEvent: 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 /approval_service/events/importApprovalPolicyEvent: 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 /approval_service/events/exportApprovalPolicyEvent: 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 /approval_service/events/importPolicyFieldEvent: 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 /approval_service/events/exportPolicyFieldEvent: 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 /approval_service/events/importPolicyFlowStepEvent: 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 /approval_service/events/exportPolicyFlowStepEvent: 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 /approval_service/events/importPolicyStepConditionEvent: 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 /approval_service/events/exportPolicyStepConditionEvent: 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 /approval_service/events/importPolicyRuleBlockEvent: 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 /approval_service/events/exportPolicyRuleBlockEvent: 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 /approval_service/events/importPolicyRuleConditionEvent: 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 /approval_service/events/exportPolicyRuleConditionEvent: 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 /approval_service/events/importPolicyApprovalRequirementEvent: 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 /approval_service/events/exportPolicyApprovalRequirementEvent: 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 /approval_service/events/importDa080ApprovalRequestEvent: 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 /approval_service/events/exportDa080ApprovalRequestEvent: 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 /approval_service/events/importAuditLogEvent: 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 /approval_service/events/exportAuditLogEvent: 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 /approval_service/events/importUserAccountEvent: 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 /approval_service/events/exportUserAccountEvent: 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 /approval_service/events/importAccessRoleEvent: 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 /approval_service/events/exportAccessRoleEvent: 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 /approval_service/events/importAccessPermissionEvent: 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 /approval_service/events/exportAccessPermissionEvent: 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 /approval_service/events/importAccessRolePermissionEvent: 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 /approval_service/events/exportAccessRolePermissionEvent: 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 /approval_service/events/importUserAccountRoleEvent: 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 /approval_service/events/exportUserAccountRoleEvent: 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 /approval_service/events/importUserSubstitutionEvent: 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 /approval_service/events/exportUserSubstitutionEvent: 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 /approval_service/entities/approvalScope: 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/approvalScope responses: 200: description: The created resource schema: #/definitions/approvalScope 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/approvalScope responses: 200: description: The created resource schema: #/definitions/approvalScope 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/approvalScope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/approvalScope/{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/editApprovalScope responses: 200: description: Ok schema: #/definitions/editApprovalScope 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/approvalScope responses: 200: description: Ok schema: #/definitions/approvalScope 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/approvalScope 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 /approval_service/entities/approvalScope/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/approvalScope responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/approvalChannel: 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/approvalChannel responses: 200: description: The created resource schema: #/definitions/approvalChannel 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/approvalChannel responses: 200: description: The created resource schema: #/definitions/approvalChannel 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/approvalChannel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/approvalChannel/{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/editApprovalChannel responses: 200: description: Ok schema: #/definitions/editApprovalChannel 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/approvalChannel responses: 200: description: Ok schema: #/definitions/approvalChannel 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/approvalChannel 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 /approval_service/entities/approvalChannel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/approvalChannel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyScenario: 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/policyScenario responses: 200: description: The created resource schema: #/definitions/policyScenario 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/policyScenario responses: 200: description: The created resource schema: #/definitions/policyScenario 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/policyScenario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyScenario/{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/editPolicyScenario responses: 200: description: Ok schema: #/definitions/editPolicyScenario 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/policyScenario responses: 200: description: Ok schema: #/definitions/policyScenario 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/policyScenario 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 /approval_service/entities/policyScenario/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyScenario responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/scopeLevel: 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/scopeLevel responses: 200: description: The created resource schema: #/definitions/scopeLevel 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/scopeLevel responses: 200: description: The created resource schema: #/definitions/scopeLevel 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/scopeLevel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/scopeLevel/{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/editScopeLevel responses: 200: description: Ok schema: #/definitions/editScopeLevel 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/scopeLevel responses: 200: description: Ok schema: #/definitions/scopeLevel 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/scopeLevel 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 /approval_service/entities/scopeLevel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scopeLevel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/scopeLevelRole: 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/scopeLevelRole responses: 200: description: The created resource schema: #/definitions/scopeLevelRole 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/scopeLevelRole responses: 200: description: The created resource schema: #/definitions/scopeLevelRole 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/scopeLevelRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/scopeLevelRole/{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/editScopeLevelRole responses: 200: description: Ok schema: #/definitions/editScopeLevelRole 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/scopeLevelRole responses: 200: description: Ok schema: #/definitions/scopeLevelRole 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/scopeLevelRole 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 /approval_service/entities/scopeLevelRole/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scopeLevelRole responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/dynamicFieldCatalog: 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/dynamicFieldCatalog responses: 200: description: The created resource schema: #/definitions/dynamicFieldCatalog 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/dynamicFieldCatalog responses: 200: description: The created resource schema: #/definitions/dynamicFieldCatalog 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/dynamicFieldCatalog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/dynamicFieldCatalog/{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/editDynamicFieldCatalog responses: 200: description: Ok schema: #/definitions/editDynamicFieldCatalog 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/dynamicFieldCatalog responses: 200: description: Ok schema: #/definitions/dynamicFieldCatalog 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/dynamicFieldCatalog 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 /approval_service/entities/dynamicFieldCatalog/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dynamicFieldCatalog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/approvalPolicy: 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/approvalPolicy responses: 200: description: The created resource schema: #/definitions/approvalPolicy 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/approvalPolicy responses: 200: description: The created resource schema: #/definitions/approvalPolicy 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/approvalPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/approvalPolicy/{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/editApprovalPolicy responses: 200: description: Ok schema: #/definitions/editApprovalPolicy 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/approvalPolicy responses: 200: description: Ok schema: #/definitions/approvalPolicy 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/approvalPolicy 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 /approval_service/entities/approvalPolicy/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/approvalPolicy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyField: 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/policyField responses: 200: description: The created resource schema: #/definitions/policyField 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/policyField responses: 200: description: The created resource schema: #/definitions/policyField 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/policyField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyField/{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/editPolicyField responses: 200: description: Ok schema: #/definitions/editPolicyField 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/policyField responses: 200: description: Ok schema: #/definitions/policyField 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/policyField 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 /approval_service/entities/policyField/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyFlowStep: 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/policyFlowStep responses: 200: description: The created resource schema: #/definitions/policyFlowStep 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/policyFlowStep responses: 200: description: The created resource schema: #/definitions/policyFlowStep 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/policyFlowStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyFlowStep/{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/editPolicyFlowStep responses: 200: description: Ok schema: #/definitions/editPolicyFlowStep 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/policyFlowStep responses: 200: description: Ok schema: #/definitions/policyFlowStep 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/policyFlowStep 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 /approval_service/entities/policyFlowStep/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyFlowStep responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyStepCondition: 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/policyStepCondition responses: 200: description: The created resource schema: #/definitions/policyStepCondition 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/policyStepCondition responses: 200: description: The created resource schema: #/definitions/policyStepCondition 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/policyStepCondition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyStepCondition/{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/editPolicyStepCondition responses: 200: description: Ok schema: #/definitions/editPolicyStepCondition 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/policyStepCondition responses: 200: description: Ok schema: #/definitions/policyStepCondition 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/policyStepCondition 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 /approval_service/entities/policyStepCondition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyStepCondition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyRuleBlock: 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/policyRuleBlock responses: 200: description: The created resource schema: #/definitions/policyRuleBlock 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/policyRuleBlock responses: 200: description: The created resource schema: #/definitions/policyRuleBlock 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/policyRuleBlock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyRuleBlock/{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/editPolicyRuleBlock responses: 200: description: Ok schema: #/definitions/editPolicyRuleBlock 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/policyRuleBlock responses: 200: description: Ok schema: #/definitions/policyRuleBlock 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/policyRuleBlock 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 /approval_service/entities/policyRuleBlock/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyRuleBlock responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyRuleCondition: 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/policyRuleCondition responses: 200: description: The created resource schema: #/definitions/policyRuleCondition 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/policyRuleCondition responses: 200: description: The created resource schema: #/definitions/policyRuleCondition 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/policyRuleCondition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyRuleCondition/{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/editPolicyRuleCondition responses: 200: description: Ok schema: #/definitions/editPolicyRuleCondition 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/policyRuleCondition responses: 200: description: Ok schema: #/definitions/policyRuleCondition 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/policyRuleCondition 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 /approval_service/entities/policyRuleCondition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyRuleCondition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyApprovalRequirement: 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/policyApprovalRequirement responses: 200: description: The created resource schema: #/definitions/policyApprovalRequirement 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/policyApprovalRequirement responses: 200: description: The created resource schema: #/definitions/policyApprovalRequirement 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/policyApprovalRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/policyApprovalRequirement/{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/editPolicyApprovalRequirement responses: 200: description: Ok schema: #/definitions/editPolicyApprovalRequirement 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/policyApprovalRequirement responses: 200: description: Ok schema: #/definitions/policyApprovalRequirement 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/policyApprovalRequirement 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 /approval_service/entities/policyApprovalRequirement/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyApprovalRequirement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/da080ApprovalRequest: 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/da080ApprovalRequest responses: 200: description: The created resource schema: #/definitions/da080ApprovalRequest 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/da080ApprovalRequest responses: 200: description: The created resource schema: #/definitions/da080ApprovalRequest 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/da080ApprovalRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/da080ApprovalRequest/{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/editDa080ApprovalRequest responses: 200: description: Ok schema: #/definitions/editDa080ApprovalRequest 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/da080ApprovalRequest responses: 200: description: Ok schema: #/definitions/da080ApprovalRequest 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/da080ApprovalRequest 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 /approval_service/entities/da080ApprovalRequest/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/da080ApprovalRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/auditLog: 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/auditLog responses: 200: description: The created resource schema: #/definitions/auditLog 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/auditLog responses: 200: description: The created resource schema: #/definitions/auditLog 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/auditLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/auditLog/{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/editAuditLog responses: 200: description: Ok schema: #/definitions/editAuditLog 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/auditLog responses: 200: description: Ok schema: #/definitions/auditLog 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/auditLog 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 /approval_service/entities/auditLog/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/auditLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userAccount: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userAccount responses: 200: description: The created resource schema: #/definitions/userAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userAccount responses: 200: description: The created resource schema: #/definitions/userAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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/userAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userAccount/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editUserAccount responses: 200: description: Ok schema: #/definitions/editUserAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userAccount responses: 200: description: Ok schema: #/definitions/userAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userAccount/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessRole: 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/accessRole responses: 200: description: The created resource schema: #/definitions/accessRole 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/accessRole responses: 200: description: The created resource schema: #/definitions/accessRole 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/accessRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessRole/{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/editAccessRole responses: 200: description: Ok schema: #/definitions/editAccessRole 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/accessRole responses: 200: description: Ok schema: #/definitions/accessRole 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/accessRole 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 /approval_service/entities/accessRole/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accessRole responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessPermission: 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/accessPermission responses: 200: description: The created resource schema: #/definitions/accessPermission 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/accessPermission responses: 200: description: The created resource schema: #/definitions/accessPermission 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/accessPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessPermission/{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/editAccessPermission responses: 200: description: Ok schema: #/definitions/editAccessPermission 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/accessPermission responses: 200: description: Ok schema: #/definitions/accessPermission 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/accessPermission 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 /approval_service/entities/accessPermission/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accessPermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessRolePermission: 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/accessRolePermission responses: 200: description: The created resource schema: #/definitions/accessRolePermission 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/accessRolePermission responses: 200: description: The created resource schema: #/definitions/accessRolePermission 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/accessRolePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/accessRolePermission/{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/editAccessRolePermission responses: 200: description: Ok schema: #/definitions/editAccessRolePermission 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/accessRolePermission responses: 200: description: Ok schema: #/definitions/accessRolePermission 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/accessRolePermission 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 /approval_service/entities/accessRolePermission/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accessRolePermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userAccountRole: 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/userAccountRole responses: 200: description: The created resource schema: #/definitions/userAccountRole 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/userAccountRole responses: 200: description: The created resource schema: #/definitions/userAccountRole 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/userAccountRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userAccountRole/{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/editUserAccountRole responses: 200: description: Ok schema: #/definitions/editUserAccountRole 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/userAccountRole responses: 200: description: Ok schema: #/definitions/userAccountRole 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/userAccountRole 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 /approval_service/entities/userAccountRole/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userAccountRole responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userSubstitution: 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/userSubstitution responses: 200: description: The created resource schema: #/definitions/userSubstitution 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/userSubstitution responses: 200: description: The created resource schema: #/definitions/userSubstitution 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/userSubstitution 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /approval_service/entities/userSubstitution/{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/editUserSubstitution responses: 200: description: Ok schema: #/definitions/editUserSubstitution 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/userSubstitution responses: 200: description: Ok schema: #/definitions/userSubstitution 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/userSubstitution 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 /approval_service/entities/userSubstitution/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userSubstitution responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim hcmUserSummary: description: Short HCM/IAM user projection used by substitution forms type: object required: – id – username properties: id: type: string description: User identifier username: type: string description: User login name: type: string description: User display name email: type: string description: Primary email active: type: boolean description: Whether the user is active roleCode: type: string description: Approval role code resolved from the HCM job title, when known roleName: type: string description: HCM job title or approval role name listHcmUserOutput: description: Paged HCM/IAM user result type: object properties: contents: type: array items: type: object allOf: – #/definitions/hcmUserSummary description: Returned users totalPages: type: integer format: int64 description: Total pages for the applied paging totalElements: type: integer format: int64 description: Total matching users approvalAccessRoleOption: description: Approval access role available to assign to platform users. type: object required: – code – name properties: code: type: string description: Stable role code name: type: string description: Display name description: type: string description: Detailed description defaultRole: type: boolean description: Whether this role is the default rolePriority: type: integer format: int64 description: Role priority approvalAccessUserSummary: description: Platform user with the current approval access profile. type: object required: – userId – username properties: userId: type: string description: User account identifier username: type: string description: User login accountName: type: string description: Account display name fullName: type: string description: User full name email: type: string description: Primary email active: type: boolean description: Whether the user is active isGlobalAdmin: type: boolean description: Whether the user is a global admin in the platform roleCode: type: string description: Current active approval role code roleName: type: string description: Current active approval role name roleDescription: type: string description: Current active approval role description assignedAt: type: string description: Current role assignment timestamp formatted by the database assignedBy: type: string description: User or system that assigned the role expiresAt: type: string description: Current role expiration timestamp formatted by the database roles: type: array items: type: string description: Application roles assigned to the user permissions: type: array items: type: string description: Application permissions resolved from the user roles listApprovalAccessUsersOutput: description: Paged platform user approval access result. type: object properties: contents: type: array items: type: object allOf: – #/definitions/approvalAccessUserSummary description: Returned users roleOptions: type: array items: type: object allOf: – #/definitions/approvalAccessRoleOption description: Available approval roles totalPages: type: integer format: int64 description: Total pages for the applied paging totalElements: type: integer format: int64 description: Total matching users changeApprovalAccessUserRoleOutput: description: Result of changing one platform users approval role. type: object properties: user: type: object allOf: – #/definitions/approvalAccessUserSummary description: Updated user roleOptions: type: array items: type: object allOf: – #/definitions/approvalAccessRoleOption description: Available approval roles listDa080ApprovalRequestStatusOutput: description: Paged DA080 approval request status result. type: object properties: contents: type: array items: type: object allOf: – #/definitions/da080ApprovalRequestStatusOutput description: Returned approval requests. totalPages: type: integer format: int64 description: Total pages for the applied paging. totalElements: type: integer format: int64 description: Total matching requests. auditLogOutput: description: Single immutable audit log row. type: object required: – id properties: id: type: string description: Audit log identifier. eventTime: type: string description: Event timestamp formatted by the database. tenantDomain: type: string description: Tenant/domain where the event happened. domainName: type: string description: Service domain. serviceName: type: string description: Service name. endpoint: type: string description: Endpoint or handler name. operation: type: string description: Business operation name. entityName: type: string description: Affected resource/entity name. entityId: type: string description: Affected resource/entity identifier. requestId: type: string description: DA080 request identifier when related. proposalNumber: type: string description: Proposal number when related. actorUserId: type: string description: Actor user login or email. actorUserName: type: string description: Actor display name. correlationId: type: string description: Correlation/request id used by the platform. status: type: string description: Execution status: SUCCESS | ERROR. errorMessage: type: string description: Error message when status is ERROR. inputPayload: type: string description: Input payload JSON. beforePayload: type: string description: State before the operation as JSON. afterPayload: type: string description: State after the operation as JSON. resultPayload: type: string description: Result payload JSON. metadataPayload: type: string description: Extra metadata JSON. listAuditLogOutput: description: Output for the audit log query. type: object properties: contents: type: array items: type: object allOf: – #/definitions/auditLogOutput description: Returned audit log entries. totalPages: type: integer format: int64 description: Total pages for the applied paging. totalElements: type: integer format: int64 description: Total records for the applied filter. approvalScopeStatusOutput: description: Output payload for approval scope status change type: object required: – scopeId – active properties: scopeId: type: string description: Scope identifier (UUID as string) active: type: boolean description: Current active flag approvalPolicyStatusOutput: description: Output payload for approval policy status change type: object required: – policyId – status – version properties: policyId: type: string description: Policy identifier (UUID as string) status: type: string description: Current status (DRAFT | ACTIVE | INACTIVE) type: integer format: int64 description: Policy version approvalPolicyCloneOutput: description: Output payload for clone policy type: object required: – sourcePolicyId – newPolicyId – version properties: sourcePolicyId: type: string description: Origin policy identifier newPolicyId: type: string description: New (cloned) policy identifier type: integer format: int64 description: New version savePolicyFieldInput: description: Single field bound to a saved policy structure type: object required: – fieldId properties: fieldId: type: string description: Dynamic field identifier required: type: boolean description: Whether the field is required for simulation default: false savePolicyFlowStepInput: description: Single approval flow step in a saved policy structure type: object required: – stepOrder – levelId properties: stepOrder: type: integer format: int64 description: Step order (1-based) levelId: type: string description: Scope level identifier validationMode: type: string maxLength: 10 description: Validation mode retained for compatibility with old step conditions default: ALL description: type: string description: Optional description savePolicyRuleBlockInput: description: Single rule block in a saved policy structure type: object required: – sourceType – name – rulePriority – resultAction – conditions properties: clientReference: type: string maxLength: 80 description: Optional client reference used to link parent/child blocks in the same save request parentBlockId: type: string description: Persisted parent block identifier for nested expressions parentClientReference: type: string maxLength: 80 description: Client reference of the parent block in the same save request targetLevelId: type: string description: Target level identifier calculated when this block matches sourceRuleId: type: string maxLength: 50 description: Legacy DA080 rule identifier sourceType: type: string maxLength: 30 description: Rule source type name: type: string maxLength: 200 description: Block display name rulePriority: type: integer format: int64 description: Evaluation priority connectorToPrevious: type: string maxLength: 10 description: Connector with the previous block connectorToParent: type: string maxLength: 10 description: Connector used when this block is evaluated as a child of another block internalConnector: type: string maxLength: 10 description: Connector used between conditions inside this block default: AND channelId: type: string description: Approval channel identifier used by this result resultAction: type: string maxLength: 40 description: Action generated by this block resultMessage: type: string description: Message generated by this block active: type: boolean description: Whether this block is active default: true ext: type: string description: Extension JSON for source metadata and exception configuration conditions: type: array items: type: object allOf: – #/definitions/savePolicyRuleConditionInput minimum: 1 description: Conditions inside this rule block savePolicyRuleConditionInput: description: Single rule condition in a saved policy structure type: object required: – fieldId – conditionOrder – operator properties: fieldId: type: string description: Dynamic field identifier conditionOrder: type: integer format: int64 description: Condition order inside the block connectorToPrevious: type: string maxLength: 10 description: Connector with the previous condition operator: type: string maxLength: 10 description: Operator: EQ | NEQ | GT | GTE | LT | LTE | BETWEEN | CONTAINS | IN valueType: type: string maxLength: 30 description: Value type used by the simulation engine: TEXT | NUMBER | BOOLEAN | DATE | LIST valueText: type: string maxLength: 500 description: Value as string (for EQ/NEQ/IN comma-separated) valueNumberMin: type: number format: double description: Numeric lower bound (BETWEEN/GT/GTE) valueNumberMax: type: number format: double description: Numeric upper bound (BETWEEN/LT/LTE) valueBoolean: type: boolean description: Boolean value used by boolean fields valueDate: type: string format: date description: Date value used by date fields valueList: type: string description: List value encoded as JSON array or comma-separated text ext: type: string description: Extension JSON for condition metadata savePolicyApprovalRequirementInput: description: Additional approval requirement saved with a policy type: object required: – requirementType properties: scenarioId: type: string description: Scenario identifier, when requirement is scenario-specific triggerRuleBlockId: type: string description: Rule block that triggers this requirement triggerRuleBlockClientReference: type: string maxLength: 80 description: Client reference of the triggering block in the same save request requirementType: type: string maxLength: 30 description: Requirement type: SEQUENTIAL | PARALLEL | ADDITIONAL | EXTERNAL | FALLBACK roleName: type: string maxLength: 200 description: Role name/code expected by the requirement channelId: type: string description: Approval channel identifier reason: type: string description: Business reason shown to the user requiresAttachment: type: boolean description: Whether an attachment is required default: false active: type: boolean description: Whether this requirement is active default: true saveApprovalPolicyStructureOutput: description: Output payload for saving a full policy structure type: object required: – policyId – version – status properties: policyId: type: string description: Policy identifier type: integer format: int64 description: Policy version status: type: string description: Policy status da080ApprovalRequestData: description: CRM-facing DA080 payload. It can carry either a normalized items list or one top-level item. type: object required: – proposalNumber properties: scopeId: type: string description: Optional scope identifier. Defaults to DA080_PROCESSO_VENDAS scope. scenarioId: type: string description: Optional scenario identifier. scenarioCode: type: string maxLength: 120 description: Optional scenario code. Defaults from items/ruleType when absent. rootCode: type: string maxLength: 120 description: Optional root code. Defaults to DA080_PROCESSO_VENDAS. proposalNumber: type: string description: Proposal number. proposalId: type: string maxLength: 80 description: CRM proposal identifier. opportunityId: type: string maxLength: 80 description: CRM opportunity identifier. proposalRevision: type: string maxLength: 40 description: Proposal revision. initialLevel: type: integer format: int64 description: Initial authority level. Defaults to 5 for CANAL and 6 otherwise. channelFlow: type: boolean description: Whether the request must use the channel approval branch. Defaults from process=CANAL when omitted. responsibleUser: type: string maxLength: 150 description: Responsible user login. approvalJustification: type: string description: Approval justification. items: type: array items: type: object allOf: – #/definitions/simulationProposalItem description: Normalized proposal item list. modality: type: string description: Top-level modality used when items is empty. value: type: number format: double description: Top-level rule value used when items is empty. totalValue: type: number format: double description: Top-level total value used when items is empty. ruleType: type: string description: Top-level rule type used when items is empty. valueType: type: string description: Top-level value type used when items is empty. process: type: string description: Top-level process name used when items is empty. interestFreeInstallments: type: integer format: int64 description: Top-level installments without interest used when items is empty. graceMonths: type: integer format: int64 description: Top-level grace months used when items is empty. monthlyFeeDiscountPercent: type: number format: double description: Top-level monthly fee discount percentage used when items is empty. graceDiscountPercent: type: number format: double description: Top-level grace discount percentage used when items is empty. travelFlexibilizationType: type: string description: Top-level travel flexibilization type used when items is empty. branchManagerExists: type: boolean description: Whether branch manager exists for fallback evaluation. campaignPromotionApplied: type: boolean description: Whether campaign/promotion is applied. competitor: type: string description: Competitor information. justification: type: string description: Business justification. requestDescription: type: string description: Request description. data: type: string description: Flexible JSON payload with extra DA080 fields. da080ApprovalLegacyResult: description: Legacy-compatible consultation result for CRM DA080. type: object required: – requiresApproval – approvalStatus properties: level: type: integer format: int64 description: Numeric DA080 level returned by the policy evaluation. message: type: string description: Human-readable message compatible with the previous DA080 response. rule: type: string description: Matched rule block identifier. object: type: string description: Legacy proprietary object string with the most restrictive proposal item. requiresApproval: type: boolean description: Whether the CRM should send the request to approval. approvalStatus: type: string maxLength: 30 description: Suggested CRM approval status: APPROVED, PENDING, BLOCKED or NO_RULE. initialLevel: type: integer format: int64 description: Initial level used in the decision. da080ApprovalDispatchStep: description: Approver resolved for the DA080 approval flow, preserving original and effective users. type: object required: – stepOrder – source – originalUserId – effectiveUserId properties: stepOrder: type: integer format: int64 description: Flow step order used for approval dispatch. source: type: string maxLength: 40 description: Source used to resolve this approver: HCM_SUPERIOR or CHANNEL_MANAGER. levelId: type: string description: Resolved level identifier, when the role is registered in DA080. levelNumber: type: integer format: int64 description: Business level number. levelName: type: string description: Resolved level name. roleCode: type: string description: Role code used to check substitutions. roleName: type: string description: Role display name. originalUserId: type: string description: Original approver user login. originalUserName: type: string description: Original approver display name. originalUserEmail: type: string description: Original approver email. effectiveUserId: type: string description: User login that must receive the approval task. effectiveUserName: type: string description: User display name that must receive the approval task. effectiveUserEmail: type: string description: User email that must receive the approval task. assignedUserId: type: string description: Current assigned user login after manual approver changes. assignedUserName: type: string description: Current assigned user display name after manual approver changes. assignedUserEmail: type: string description: Current assigned user email after manual approver changes. status: type: string maxLength: 30 description: Step status when this dispatch step was materialized: WAITING | PENDING | APPROVED | REJECTED | CANCELED. decisionUserId: type: string description: User that approved or rejected this step. decisionUserName: type: string description: Decision user display name. decisionAt: type: string description: Decision timestamp formatted by the database. decisionComment: type: string description: Decision comment or rejection reason. lastChangedBy: type: string description: Last administrator that changed the assigned approver. lastChangedAt: type: string description: Last approver change timestamp formatted by the database. changeReason: type: string description: Last approver change reason. substituted: type: boolean description: Whether a current userSubstitution rule changed the effective user. default: false substitutionId: type: string description: Applied userSubstitution identifier. bpmProcessId: type: string maxLength: 150 description: BPM process identifier used by this approval step. bpmProcessInstanceId: type: string maxLength: 150 description: Platform BPM process instance identifier for this approval step. bpmStatus: type: string maxLength: 30 description: Latest BPM integration status for this approval step. bpmLastError: type: string description: Latest BPM integration error for this approval step, when any. da080ApprovalConsultOutput: description: Output for the DA080 CRM consultation endpoint. type: object required: – simulation – legacy properties: scopeId: type: string description: Normalized scope identifier used in the simulation. scenarioCode: type: string description: Normalized scenario code used in the simulation. rootCode: type: string description: Normalized root code used in the simulation. simulation: type: object allOf: – #/definitions/simulationResult description: Structured policy simulation result. legacy: type: object allOf: – #/definitions/da080ApprovalLegacyResult description: Legacy-compatible CRM consultation fields. da080ApprovalRequestOutput: description: Output for the DA080 request persistence endpoint. type: object required: – requestId – requestStatus – simulation – legacy properties: requestId: type: string description: Stored DA080 request identifier. requestStatus: type: string maxLength: 30 description: Current request status. hierarchyJobId: type: string description: Hierarchy preparation job identifier, when approval flow will be resolved asynchronously. hierarchyStatus: type: string maxLength: 30 description: Hierarchy preparation status: NOT_REQUIRED | PENDING | PROCESSING | READY | RETRY | ERROR | DEAD. channelFlow: type: boolean description: Whether this request used the channel approval branch. approvalFlow: type: array items: type: object allOf: – #/definitions/da080ApprovalDispatchStep description: Resolved original/effective approvers prepared for approval. simulation: type: object allOf: – #/definitions/simulationResult description: Structured policy simulation result. legacy: type: object allOf: – #/definitions/da080ApprovalLegacyResult description: Legacy-compatible CRM consultation fields. da080ApprovalHierarchyJobOutput: description: Async HCM hierarchy job status for a DA080 approval request. type: object required: – jobId – status properties: jobId: type: string description: Hierarchy preparation job identifier. status: type: string maxLength: 30 description: Current job status: PENDING | PROCESSING | READY | RETRY | ERROR | DEAD. attempts: type: integer format: int64 description: Current retry attempt count. maxAttempts: type: integer format: int64 description: Maximum retry attempts. nextRetryAt: type: string description: Next retry timestamp formatted by the database. lockedAt: type: string description: Job lock timestamp formatted by the database. finishedAt: type: string description: Job finish timestamp formatted by the database. lastError: type: string description: Last retry/dead-letter error. da080ApprovalHierarchyEntry: description: Persisted original/effective approver row resolved from HCM or channel manager. type: object required: – sourceOrder – source – originalUserId – effectiveUserId properties: sourceOrder: type: integer format: int64 description: Source order returned by the hierarchy provider. source: type: string maxLength: 40 description: Source used to resolve this approver: HCM_SUPERIOR or CHANNEL_MANAGER. originalUserId: type: string description: Original approver user login. originalUserName: type: string description: Original approver display name. originalRoleName: type: string description: Original role name returned by HCM/channel configuration. roleCode: type: string description: Resolved role code used for substitutions. roleName: type: string description: Resolved role display name. levelNumber: type: integer format: int64 description: Business level number. effectiveUserId: type: string description: User login that must receive the approval task. effectiveUserName: type: string description: User display name that must receive the approval task. substituted: type: boolean description: Whether a current userSubstitution rule changed the effective user. default: false substitutionId: type: string description: Applied userSubstitution identifier. dispatchable: type: boolean description: Whether this row is part of the approval dispatch flow. default: false da080ApprovalRequestStatusOutput: description: Output for the DA080 request status endpoint. type: object required: – requestId – proposalNumber – requestStatus – requiresApproval properties: requestId: type: string description: Stored DA080 request identifier. externalSystem: type: string description: Caller system, for example crm. approvalKey: type: string description: Approval business key, for example orders. scenarioId: type: string description: Scenario identifier used for simulation. scenarioCode: type: string description: Scenario code used for simulation. rootCode: type: string description: Root code used for simulation. proposalNumber: type: string description: Proposal number. proposalId: type: string description: CRM proposal identifier. requestStatus: type: string maxLength: 30 description: Current request status. bpmProcessId: type: string maxLength: 150 description: Latest BPM process identifier used by the request. bpmProcessInstanceId: type: string maxLength: 150 description: Latest Platform BPM process instance identifier. bpmStatus: type: string maxLength: 30 description: Latest BPM integration status for the request. bpmLastError: type: string description: Latest BPM integration error for the request, when any. createdAt: type: string description: Request creation timestamp formatted by the database. targetLevelNumber: type: integer format: int64 description: Target DA080 approval level. requiresApproval: type: boolean description: Whether this request requires approval. channelFlow: type: boolean description: Whether this request used the channel approval branch. hierarchyStatus: type: string maxLength: 30 description: Hierarchy preparation status read from the latest job or stored payload. hierarchyJobId: type: string description: Hierarchy preparation job identifier. hierarchyJob: type: object allOf: – #/definitions/da080ApprovalHierarchyJobOutput description: Async HCM hierarchy job status. hierarchy: type: array items: type: object allOf: – #/definitions/da080ApprovalHierarchyEntry description: Persisted HCM/channel hierarchy rows. approvalFlow: type: array items: type: object allOf: – #/definitions/da080ApprovalDispatchStep description: Dispatchable original/effective approvers prepared for approval. currentStep: type: object allOf: – #/definitions/da080ApprovalStepStatus description: Current pending approval step, when the request is waiting for an approver. steps: type: array items: type: object allOf: – #/definitions/da080ApprovalStepStatus description: Persisted approval steps and their decision status. history: type: array items: type: object allOf: – #/definitions/da080ApprovalHistoryEntry description: Functional audit history for approvals, rejections and approver changes. approvalPayload: type: string description: Stored approval workflow payload after hierarchy status updates. da080ApprovalStepStatus: description: Persisted status of a DA080 approval step. type: object required: – stepId – stepOrder – assignedUserId – status properties: stepId: type: string description: Approval step identifier. stepOrder: type: integer format: int64 description: Step order inside the DA080 approval workflow. source: type: string maxLength: 40 description: Source used to resolve this approver: HCM_SUPERIOR or CHANNEL_MANAGER. levelId: type: string description: Resolved level identifier. levelNumber: type: integer format: int64 description: Business level number. levelName: type: string description: Resolved level name. roleCode: type: string description: Role code used by the approval step. roleName: type: string description: Role display name. originalUserId: type: string description: Original approver user login returned by HCM/channel configuration. originalUserName: type: string description: Original approver display name. originalUserEmail: type: string description: Original approver email. effectiveUserId: type: string description: Approver after automatic substitution rules. effectiveUserName: type: string description: Display name after automatic substitution rules. effectiveUserEmail: type: string description: Email after automatic substitution rules. assignedUserId: type: string description: Current user assigned to decide this step. assignedUserName: type: string description: Current assigned user display name. assignedUserEmail: type: string description: Current assigned user email. substituted: type: boolean description: Whether a current userSubstitution rule changed the effective user. default: false substitutionId: type: string description: Applied userSubstitution identifier. status: type: string maxLength: 30 description: Step status: WAITING | PENDING | APPROVED | REJECTED | CANCELED. decisionUserId: type: string description: User that approved or rejected this step. decisionUserName: type: string description: Decision user display name. decisionAt: type: string description: Decision timestamp formatted by the database. decisionComment: type: string description: Decision comment or rejection reason. lastChangedBy: type: string description: Last administrator that changed the assigned approver. lastChangedAt: type: string description: Last approver change timestamp formatted by the database. changeReason: type: string description: Last approver change reason. bpmProcessId: type: string maxLength: 150 description: BPM process identifier used by this approval step. bpmProcessInstanceId: type: string maxLength: 150 description: Platform BPM process instance identifier for this approval step. bpmStatus: type: string maxLength: 30 description: Latest BPM integration status for this approval step. bpmLastError: type: string description: Latest BPM integration error for this approval step, when any. da080ApprovalHistoryEntry: description: Functional audit entry for DA080 approval workflow decisions. type: object required: – eventId – requestId – eventType properties: eventId: type: string description: Audit event identifier. requestId: type: string description: Stored DA080 request identifier. stepId: type: string description: Approval step identifier, when the event is step-related. stepOrder: type: integer format: int64 description: Approval step order, when the event is step-related. eventType: type: string maxLength: 40 description: Event type: STEP_CREATED | STEP_APPROVED | STEP_REJECTED | APPROVER_CHANGED | REQUEST_APPROVED | REQUEST_REJECTED. actorUserId: type: string description: User login that executed the event. actorUserName: type: string description: Actor display name. fromUserId: type: string description: Previous assigned approver user login, when changed. fromUserName: type: string description: Previous assigned approver display name, when changed. fromUserEmail: type: string description: Previous assigned approver email, when changed. toUserId: type: string description: New assigned approver user login, when changed. toUserName: type: string description: New assigned approver display name, when changed. toUserEmail: type: string description: New assigned approver email, when changed. statusFrom: type: string maxLength: 30 description: Previous status, when applicable. statusTo: type: string maxLength: 30 description: New status, when applicable. comment: type: string description: Decision comment, rejection reason or change reason. createdAt: type: string description: Event creation timestamp formatted by the database. eventPayload: type: string description: Additional event payload. da080ApprovalWorkflowOutput: description: Output for DA080 approval workflow mutations. type: object required: – requestId – requestStatus properties: requestId: type: string description: Stored DA080 request identifier. requestStatus: type: string maxLength: 30 description: Current request status. currentStep: type: object allOf: – #/definitions/da080ApprovalStepStatus description: Current pending approval step, when any. steps: type: array items: type: object allOf: – #/definitions/da080ApprovalStepStatus description: Persisted approval steps and their decision status. history: type: array items: type: object allOf: – #/definitions/da080ApprovalHistoryEntry description: Functional audit history for approvals, rejections and approver changes. approvalPayload: type: string description: Stored approval workflow payload after the mutation. da080ApprovalCancelOutput: description: Output for the DA080 cancellation endpoint. type: object required: – requestStatus properties: requestId: type: string description: Stored DA080 request identifier, when found. requestStatus: type: string maxLength: 30 description: Current request status. cancelPayload: type: string description: Stored cancellation payload. simulationProposalItem: description: Single proposal item used as simulation input type: object properties: modality: type: string description: Commercial modality value: type: number format: double description: Rule value totalValue: type: number format: double description: Total value ruleType: type: string description: Rule type valueType: type: string description: Value type process: type: string description: Process name interestFreeInstallments: type: integer format: int64 description: Installments without interest graceMonths: type: integer format: int64 description: Grace months monthlyFeeDiscountPercent: type: number format: double description: Monthly fee discount percentage graceDiscountPercent: type: number format: double description: Grace discount percentage travelFlexibilizationType: type: string description: Travel flexibilization type branchManagerExists: type: boolean description: Whether branch manager exists for fallback evaluation campaignPromotionApplied: type: boolean description: Whether campaign/promotion is applied competitor: type: string description: Competitor information justification: type: string description: Business justification requestDescription: type: string description: Request description data: type: string description: Flexible JSON payload with extra DA080 fields simulationTargetLevel: description: Target approval level returned by simulation type: object properties: levelId: type: string description: Resolved level identifier levelNumber: type: integer format: int64 description: Business level number name: type: string description: Resolved level name simulationMatchedRuleBlock: description: Rule block matched during simulation type: object required: – ruleBlockId – name – rulePriority properties: ruleBlockId: type: string description: Rule block identifier name: type: string description: Block display name rulePriority: type: integer format: int64 description: Evaluation priority targetLevelId: type: string description: Target level identifier targetLevelName: type: string description: Target level name resultAction: type: string description: Action generated by this rule block channelId: type: string description: Approval channel identifier returned by this block simulationAppliedException: description: Exception applied during simulation type: object properties: sourceRuleId: type: string description: Exception source rule identifier message: type: string description: Result message simulationApprovalStep: description: Single level inside the calculated approval path type: object required: – stepOrder – levelId – levelName – roleCodes properties: stepOrder: type: integer format: int64 description: Flow step order levelId: type: string description: Resolved level identifier levelNumber: type: integer format: int64 description: Business level number levelName: type: string description: Resolved level name roleCodes: type: array items: type: string minimum: 1 description: List of role codes that may approve this step simulationApprovalRequirement: description: Additional approval requirement returned by simulation type: object required: – requirementType properties: requirementId: type: string description: Requirement identifier triggerRuleBlockId: type: string description: Rule block that triggered the requirement requirementType: type: string description: Requirement type roleName: type: string description: Role name/code expected by the requirement channelId: type: string description: Approval channel identifier reason: type: string description: Business reason requiresAttachment: type: boolean description: Whether an attachment is required simulationResult: description: Final simulation result type: object required: – proposalNumber – matchedRuleBlocks – approvalPath – ignoredSteps – requirements – messages properties: policyId: type: string description: Active policy identifier used in the simulation policyVersion: type: integer format: int64 description: Active policy version scenarioId: type: string description: Scenario identifier used in the simulation scenarioCode: type: string description: Scenario code used in the simulation proposalNumber: type: string description: Proposal number targetLevel: type: object allOf: – #/definitions/simulationTargetLevel description: Resolved target approval level matchedRuleBlocks: type: array items: type: object allOf: – #/definitions/simulationMatchedRuleBlock minimum: 1 description: Rule blocks matched during evaluation appliedException: type: object allOf: – #/definitions/simulationAppliedException description: Exception applied during evaluation approvalPath: type: array items: type: object allOf: – #/definitions/simulationApprovalStep minimum: 1 description: Sequential approval path up to target level ignoredSteps: type: array items: type: object allOf: – #/definitions/simulationApprovalStep minimum: 1 description: Flow steps ignored because they are below the target level requirements: type: array items: type: object allOf: – #/definitions/simulationApprovalRequirement minimum: 1 description: Additional approval requirements, channels and fallbacks returned by matched blocks messages: type: array items: type: string minimum: 1 description: Human-readable simulation messages recAccess: description: type: object required: – accessToken – credential properties: accessToken: type: string description: credential: type: string description: loginUserInformation: description: type: object required: – photo – username – fullName – locale – active – isGlobalAdmin properties: photo: type: string description: username: type: string description: fullName: type: string description: locale: type: string description: active: type: boolean description: isGlobalAdmin: type: boolean description: roles: type: array items: type: string description: Application roles assigned to the logged user permissions: type: array items: type: string description: Application permissions resolved from the logged user roles accountInformation: description: type: object properties: dn: type: string description: Identification username: type: string description: accountName: type: string description: fullName: type: string description: phoneNumber: type: string description: Contact photo: type: string description: email: type: string description: tenantDomain: type: string description: Tenant information tenantName: type: string description: locale: type: string description: pwdLastSet: type: string description: Password information lockoutTime: type: string description: approvalScope: description: Approval scope (alçada). Root entity for the approval configuration model. type: object required: – name – hierarchyType properties: id: type: string format: uuid description: Unique identifier name: type: string maxLength: 120 description: Display name of the scope technicalCode: type: string maxLength: 80 description: Auto-generated technical code, unique per scope (filled by backend) readOnly: true description: type: string description: Detailed description hierarchyType: type: string maxLength: 30 description: Hierarchy resolution type (HCM_INTEGRATION | CUSTOM | FIXED) hierarchySource: type: string maxLength: 120 description: Source identifier when hierarchy depends on an external system active: type: boolean description: Whether the scope is active default: true fallbackToNextAvailableLevel: type: boolean description: When target level is absent for a requester, fallback to the next available stronger level default: true editApprovalScope: type: object required: – id allOf: – #/definitions/approvalScope approvalChannel: description: Approval channel used by DA080 scenarios, rules and additional requirements. type: object required: – code – name properties: id: type: string format: uuid description: Unique identifier code: type: string maxLength: 80 description: Unique channel code name: type: string maxLength: 160 description: Display name description: type: string description: Detailed description active: type: boolean description: Whether the channel is active default: true editApprovalChannel: type: object required: – id allOf: – #/definitions/approvalChannel policyScenario: description: DA080 policy scenario, for example 7.1.2 desconto em mensalidade. type: object required: – scopeId – code – name properties: id: type: string format: uuid description: Unique identifier scopeId: type: string maxLength: 36 description: Parent approval scope identifier code: type: string maxLength: 120 description: Unique scenario code within the scope name: type: string maxLength: 200 description: Display name description: type: string description: Detailed description channelId: type: string maxLength: 36 description: Default approval channel for the scenario active: type: boolean description: Whether the scenario is active default: true editPolicyScenario: type: object required: – id allOf: – #/definitions/policyScenario scopeLevel: description: Hierarchy level inside an approval scope (cargo / nivel). type: object required: – scopeId – name – levelOrder properties: id: type: string format: uuid description: Unique identifier scopeId: type: string maxLength: 36 description: Parent approval scope identifier (UUID as string) name: type: string maxLength: 120 description: Display name of the level technicalCode: type: string maxLength: 80 description: Optional technical code of the level levelOrder: type: integer format: int64 description: Hierarchy order inside the scope (0 = lower, higher = stronger) levelNumber: type: integer format: int64 description: Business approval level number (DA080 N0, N1, …) active: type: boolean description: Whether the level is active default: true editScopeLevel: type: object required: – id allOf: – #/definitions/scopeLevel scopeLevelRole: description: Role attached to a scope level. Multiple roles can belong to a single level. type: object required: – levelId – roleCode properties: id: type: string format: uuid description: Unique identifier levelId: type: string maxLength: 36 description: Parent scope level identifier (UUID as string) roleCode: type: string maxLength: 120 description: Role code (matches IAM/HCM role) roleName: type: string maxLength: 200 description: Role display name active: type: boolean description: Whether the role is active default: true editScopeLevelRole: type: object required: – id allOf: – #/definitions/scopeLevelRole dynamicFieldCatalog: description: Dynamic field catalog: extra attributes that can be evaluated by policies in a given scope. type: object required: – scopeId – fieldCode – label – dataType properties: id: type: string format: uuid description: Unique identifier scopeId: type: string maxLength: 36 description: Parent approval scope identifier (UUID as string) scenarioId: type: string maxLength: 36 description: Scenario identifier when the field is specific to one DA080 scenario fieldCode: type: string maxLength: 120 description: Unique field code per scope (e.g. PERCENT_DISCOUNT) label: type: string maxLength: 200 description: Human readable label dataType: type: string maxLength: 20 description: Data type: STRING | NUMBER | DECIMAL | BOOLEAN | DATE | LIST required: type: boolean description: Whether the field is mandatory when evaluating policies default: false active: type: boolean description: Whether the field is active and can be referenced by new policies default: true editDynamicFieldCatalog: type: object required: – id allOf: – #/definitions/dynamicFieldCatalog approvalPolicy: description: Approval policy: versioned set of fields + flow steps + conditions for a scope+rootCode. type: object required: – scopeId – rootCode – name properties: id: type: string format: uuid description: Unique identifier scopeId: type: string maxLength: 36 description: Parent approval scope identifier scenarioId: type: string maxLength: 36 description: Scenario identifier when this policy is scoped to one DA080 scenario rootCode: type: string maxLength: 120 description: Business root code (e.g. CANAL_SAAS_DESCONTOS_PCT) type: integer format: int64 description: Policy version (incremental, unique per scopeId+rootCode; filled by backend) status: type: string maxLength: 20 description: Status: DRAFT | ACTIVE | INACTIVE (filled by backend) name: type: string maxLength: 200 description: Display name description: type: string description: Description effectiveFrom: type: string format: date description: Effective from (ISO date) effectiveTo: type: string format: date description: Effective to (ISO date) editApprovalPolicy: type: object required: – id allOf: – #/definitions/approvalPolicy policyField: description: Policy field binding: declares which dynamic fields are evaluated by a policy. type: object required: – policyId – fieldId properties: id: type: string format: uuid description: Unique identifier policyId: type: string maxLength: 36 description: Parent policy identifier fieldId: type: string maxLength: 36 description: Dynamic field identifier required: type: boolean description: Override of required flag at policy level default: false editPolicyField: type: object required: – id allOf: – #/definitions/policyField policyFlowStep: description: Policy flow step: one step in the approval flow (links a scopeLevel to the policy). type: object required: – policyId – stepOrder – levelId properties: id: type: string format: uuid description: Unique identifier policyId: type: string maxLength: 36 description: Parent policy identifier stepOrder: type: integer format: int64 description: Step order (1-based) levelId: type: string maxLength: 36 description: Scope level identifier resolved at this step validationMode: type: string maxLength: 10 description: Validation mode: ALL | ANY (how conditions are combined) default: ALL description: type: string description: Optional description editPolicyFlowStep: type: object required: – id allOf: – #/definitions/policyFlowStep policyStepCondition: description: Policy step condition: predicate evaluated against simulation input. type: object required: – stepId – fieldId – operator properties: id: type: string format: uuid description: Unique identifier stepId: type: string maxLength: 36 description: Parent flow step identifier fieldId: type: string maxLength: 36 description: Field identifier (references dynamicFieldCatalog) operator: type: string maxLength: 10 description: Operator: EQ | NEQ | GT | GTE | LT | LTE | BETWEEN | IN valueText: type: string maxLength: 500 description: Value as string (for EQ/NEQ/IN comma-separated) valueNumberMin: type: number format: double description: Numeric lower bound (BETWEEN/GT/GTE) valueNumberMax: type: number format: double description: Numeric upper bound (BETWEEN/LT/LTE) editPolicyStepCondition: type: object required: – id allOf: – #/definitions/policyStepCondition policyRuleBlock: description: Policy rule block: group of conditions that resolves to a target approval level. type: object required: – policyId – sourceType – name – rulePriority – resultAction properties: id: type: string format: uuid description: Unique identifier policyId: type: string maxLength: 36 description: Parent policy identifier parentBlockId: type: string maxLength: 36 description: Parent block identifier for nested expressions targetLevelId: type: string maxLength: 36 description: Target scope level identifier sourceRuleId: type: string maxLength: 50 description: Legacy DA080 rule identifier sourceType: type: string maxLength: 30 description: Rule source type name: type: string maxLength: 200 description: Block display name rulePriority: type: integer format: int64 description: Evaluation priority connectorToPrevious: type: string maxLength: 10 description: Connector with the previous block connectorToParent: type: string maxLength: 10 description: Connector used when this block is evaluated as a child of another block internalConnector: type: string maxLength: 10 description: Connector used between conditions inside this block default: AND channelId: type: string maxLength: 36 description: Approval channel identifier used by this result resultAction: type: string maxLength: 40 description: Action generated by this block resultMessage: type: string description: Message generated by this block active: type: boolean description: Whether the rule block is active default: true editPolicyRuleBlock: type: object required: – id allOf: – #/definitions/policyRuleBlock policyRuleCondition: description: Policy rule condition: predicate evaluated inside a policy rule block. type: object required: – ruleBlockId – fieldId – conditionOrder – operator properties: id: type: string format: uuid description: Unique identifier ruleBlockId: type: string maxLength: 36 description: Parent rule block identifier fieldId: type: string maxLength: 36 description: Dynamic field identifier conditionOrder: type: integer format: int64 description: Condition order inside the block connectorToPrevious: type: string maxLength: 10 description: Connector with the previous condition operator: type: string maxLength: 10 description: Operator: EQ | NEQ | GT | GTE | LT | LTE | BETWEEN | IN valueType: type: string maxLength: 30 description: Value type used by the simulation engine: TEXT | NUMBER | BOOLEAN | DATE | LIST valueText: type: string maxLength: 500 description: Value as string (for EQ/NEQ/IN comma-separated) valueNumberMin: type: number format: double description: Numeric lower bound (BETWEEN/GT/GTE) valueNumberMax: type: number format: double description: Numeric upper bound (BETWEEN/LT/LTE) valueBoolean: type: boolean description: Boolean value used by boolean fields valueDate: type: string format: date description: Date value used by date fields valueList: type: string description: List value encoded as JSON array or comma-separated text editPolicyRuleCondition: type: object required: – id allOf: – #/definitions/policyRuleCondition policyApprovalRequirement: description: Additional approval requirement or fallback triggered by DA080 rule blocks. type: object required: – policyId – requirementType properties: id: type: string format: uuid description: Unique identifier policyId: type: string maxLength: 36 description: Parent policy identifier scenarioId: type: string maxLength: 36 description: Scenario identifier, when requirement is scenario-specific triggerRuleBlockId: type: string maxLength: 36 description: Rule block that triggers this requirement requirementType: type: string maxLength: 30 description: Requirement type: SEQUENTIAL | PARALLEL | ADDITIONAL | EXTERNAL | FALLBACK roleName: type: string maxLength: 200 description: Role name/code expected by the requirement channelId: type: string maxLength: 36 description: Approval channel identifier reason: type: string description: Business reason shown to the user requiresAttachment: type: boolean description: Whether an attachment is required default: false active: type: boolean description: Whether this requirement is active default: true editPolicyApprovalRequirement: type: object required: – id allOf: – #/definitions/policyApprovalRequirement da080ApprovalRequest: description: DA080 request received from CRM and evaluated by the approval engine. type: object required: – externalSystem – approvalKey – proposalNumber – requestStatus properties: id: type: string format: uuid description: Unique identifier externalSystem: type: string maxLength: 40 description: Caller system, for example crm approvalKey: type: string maxLength: 80 description: Approval business key, for example orders scopeId: type: string maxLength: 36 description: Scope identifier used for simulation scenarioId: type: string maxLength: 36 description: Scenario identifier used for simulation scenarioCode: type: string maxLength: 120 description: Scenario code used for simulation rootCode: type: string maxLength: 120 description: Root code used for simulation proposalNumber: type: string maxLength: 80 description: Proposal number proposalId: type: string maxLength: 80 description: CRM proposal identifier opportunityId: type: string maxLength: 80 description: CRM opportunity identifier proposalRevision: type: string maxLength: 40 description: Proposal revision requestStatus: type: string maxLength: 30 description: Request status: CONSULTED | APPROVED | PENDING_APPROVAL | REJECTED | BLOCKED | CANCELED targetLevelNumber: type: integer format: int64 description: Target DA080 level number targetLevelId: type: string maxLength: 36 description: Target scope level identifier requiresApproval: type: boolean description: Whether the request must be sent to approval default: false requestPayload: type: string description: Raw normalized request payload simulationPayload: type: string description: Simulation input payload simulationResultPayload: type: string description: Simulation result payload approvalPayload: type: string description: Approval workflow payload cancelPayload: type: string description: Cancellation workflow payload bpmProcessId: type: string maxLength: 150 description: BPM process identifier used for the latest DA080 process instance. bpmProcessInstanceId: type: string maxLength: 150 description: Latest Platform BPM process instance identifier. bpmStatus: type: string maxLength: 30 description: Latest BPM integration status. bpmLastError: type: string description: Latest BPM integration error, when any. bpmStartedAt: type: string format: date-time description: Latest BPM process start timestamp. bpmCanceledAt: type: string format: date-time description: Latest BPM process cancellation timestamp. editDa080ApprovalRequest: type: object required: – id allOf: – #/definitions/da080ApprovalRequest auditLog: description: Immutable technical audit log for approval_service operations. type: object required: – domainName – serviceName – operation – status properties: id: type: string format: uuid description: Unique identifier eventTime: type: string format: date-time description: Event timestamp. tenantDomain: type: string maxLength: 200 description: Tenant/domain where the event happened. domainName: type: string maxLength: 80 description: Service domain. serviceName: type: string maxLength: 120 description: Service name. endpoint: type: string maxLength: 160 description: Endpoint or handler name. operation: type: string maxLength: 80 description: Business operation name. entityName: type: string maxLength: 120 description: Affected resource/entity name. entityId: type: string maxLength: 120 description: Affected resource/entity identifier. requestId: type: string maxLength: 36 description: DA080 request identifier when related. proposalNumber: type: string maxLength: 80 description: Proposal number when related. actorUserId: type: string maxLength: 150 description: Actor user login or email. actorUserName: type: string maxLength: 200 description: Actor display name. correlationId: type: string maxLength: 120 description: Correlation/request id used by the platform. status: type: string maxLength: 20 description: Execution status: SUCCESS | ERROR. errorMessage: type: string description: Error message when status is ERROR. inputPayload: type: string description: Input payload JSON. beforePayload: type: string description: State before the operation as JSON. afterPayload: type: string description: State after the operation as JSON. resultPayload: type: string description: Result payload JSON. metadataPayload: type: string description: Extra metadata JSON. editAuditLog: type: object required: – id allOf: – #/definitions/auditLog userAccount: description: User Account Information (Active Directory / IAM) type: object required: – dn – username properties: id: type: string format: uuid description: Unique identifier dn: type: string maxLength: 500 description: Distinguished Name (DN) from Active Directory username: type: string maxLength: 150 description: Username (login) accountName: type: string maxLength: 150 description: Account display name fullName: type: string maxLength: 200 description: User full name photo: type: string format: byte description: User photo phoneNumber: type: string maxLength: 50 description: Phone number email: type: string maxLength: 200 description: Primary email tenantDomain: type: string maxLength: 200 description: Tenant domain tenantName: type: string maxLength: 150 description: Tenant name locale: type: string maxLength: 20 description: Locale configuration (e.g. pt-BR) active: type: boolean description: Valid user default: true isGlobalAdmin: type: boolean description: Is admin default: false editUserAccount: type: object required: – id allOf: – #/definitions/userAccount accessRole: description: Application access role used by the approval hub. type: object required: – code – name properties: id: type: string format: uuid description: Unique identifier code: type: string maxLength: 80 description: Stable role code name: type: string maxLength: 160 description: Display name description: type: string description: Detailed description active: type: boolean description: Whether the role is active default: true defaultRole: type: boolean description: Whether this role is assigned to users without an active role default: false rolePriority: type: integer format: int64 description: Role priority for deterministic ordering default: 0 editAccessRole: type: object required: – id allOf: – #/definitions/accessRole accessPermission: description: Atomic application permission used by approval roles. type: object required: – code – name properties: id: type: string format: uuid description: Unique identifier code: type: string maxLength: 120 description: Stable permission code name: type: string maxLength: 160 description: Display name description: type: string description: Detailed description active: type: boolean description: Whether the permission is active default: true editAccessPermission: type: object required: – id allOf: – #/definitions/accessPermission accessRolePermission: description: Permission attached to an application access role. type: object required: – roleId – permissionId properties: id: type: string format: uuid description: Unique identifier roleId: type: string maxLength: 36 description: Parent role identifier permissionId: type: string maxLength: 36 description: Permission identifier active: type: boolean description: Whether the relationship is active default: true editAccessRolePermission: type: object required: – id allOf: – #/definitions/accessRolePermission userAccountRole: description: Application access role assigned to a user account. type: object required: – userId – roleId properties: id: type: string format: uuid description: Unique identifier userId: type: string maxLength: 36 description: User account identifier roleId: type: string maxLength: 36 description: Access role identifier assignedAt: type: string format: date-time description: Assignment timestamp assignedBy: type: string maxLength: 150 description: User or system that assigned the role expiresAt: type: string format: date-time description: Optional expiration timestamp active: type: boolean description: Whether the assignment is active default: true editUserAccountRole: type: object required: – id allOf: – #/definitions/userAccountRole userSubstitution: description: Temporary approver substitution rule for a user and role. type: object required: – substitutedUserId – substitutedUserName – substituteUserId – substituteUserName – startDate – endDate properties: id: type: string format: uuid description: Unique identifier substitutedUserId: type: string maxLength: 120 description: User identifier that will be replaced substitutedUserName: type: string maxLength: 200 description: Display name of the replaced user substitutedUserEmail: type: string maxLength: 200 description: Email of the replaced user substituteUserId: type: string maxLength: 120 description: User identifier that will receive the approvals substituteUserName: type: string maxLength: 200 description: Display name of the substitute user substituteUserEmail: type: string maxLength: 200 description: Email of the substitute user roleCode: type: string maxLength: 120 description: Optional role code kept for old rules; the substitution applies to every role of the replaced user roleName: type: string maxLength: 200 description: Role display name startDate: type: string format: date description: First day of validity endDate: type: string format: date description: Last day of validity reason: type: string description: Business reason active: type: boolean description: Whether the rule is active default: true status: type: string maxLength: 20 description: Calculated status: CURRENT | SCHEDULED | EXPIRED | INACTIVE editUserSubstitution: type: object required: – id allOf: – #/definitions/userSubstitution 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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