2.0info: 3.13.0 sara_tic_backend x-senior-domain: tic_arq x-senior-domain-path: tic_arq x-senior-service-path: sara_tic_backend 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: /sara_tic_backend/queries/healthcheck: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/recHealthcheckOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/recHealthcheckOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/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 /sara_tic_backend/queries/exportInitialAction: 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 /sara_tic_backend/queries/exportBotConfiguration: 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 /sara_tic_backend/queries/exportInteractionType: 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 /sara_tic_backend/queries/exportBotConfigurationInitialAction: 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 /sara_tic_backend/queries/exportDialog: 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 /sara_tic_backend/queries/exportSession: 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 /sara_tic_backend/queries/exportInteraction: 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 /sara_tic_backend/queries/exportZendeskProductUser: 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 /sara_tic_backend/queries/exportFeedback: 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 /sara_tic_backend/queries/exportSupportSystems: 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 /sara_tic_backend/queries/exportBotConfigurationSupportSystems: 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 /sara_tic_backend/queries/exportSupportSystemsPredefinedPaths: 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 /sara_tic_backend/queries/exportRecoveryCode: 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 /sara_tic_backend/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 /sara_tic_backend/actions/ellevoOpenTicket: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – ticket – recaptcha properties: baseInformation: type: string description: ticket: type: object allOf: – #/definitions/recOpenTicketEllevo description: recaptcha: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation – ticketResponse properties: baseInformation: type: string description: ticketResponse: type: object allOf: – #/definitions/recEllevoOpenTicketResponse description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getNatureAndSeverity: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – pathId properties: baseInformation: type: string description: pathId: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation – nature – severities – ellevoUserInfo properties: baseInformation: type: string description: nature: type: object allOf: – #/definitions/recNature description: severities: type: array items: type: object allOf: – #/definitions/recSeverities minimum: 1 description: ellevoUserInfo: type: object allOf: – #/definitions/recEllevoUserInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getPriorityAndPaths: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – pathInformation properties: baseInformation: type: string description: pathInformation: type: object allOf: – #/definitions/recPathsInformation description: responses: 200: description: Ok schema: type: object required: – baseInformation – priorities – paths properties: baseInformation: type: string description: priorities: type: array items: type: object allOf: – #/definitions/recPriorities minimum: 1 description: paths: type: array items: type: object allOf: – #/definitions/recPaths minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getSupportSystemPredefinedPaths: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation – predefinedPaths properties: baseInformation: type: string description: predefinedPaths: type: array items: type: object allOf: – #/definitions/recSupportSystemPredefinedPaths minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getAccountInformation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – accountQuery – origin properties: baseInformation: type: string description: accountQuery: type: object allOf: – #/definitions/recAccountQuery description: origin: type: string allOf: – #/definitions/interactionTags description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/index: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – info properties: info: type: object allOf: – #/definitions/recIndexInfo description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/generativeIndex: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – info – generativeChat properties: info: type: object allOf: – #/definitions/recIndexInfo description: generativeChat: type: object allOf: – #/definitions/recGenerativeChat description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/finishContext: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getSoftwareForDownloadList: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation – softwareList properties: baseInformation: type: string description: softwareList: type: array items: type: object allOf: – #/definitions/recSoftwareList minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/softwareInstallation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – software properties: baseInformation: type: string description: software: type: object allOf: – #/definitions/recSoftwareInstallation description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object required: – baseInformation – status properties: baseInformation: type: string description: status: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/feedBackSara: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – feedBackSara properties: baseInformation: type: string description: feedBackSara: type: object allOf: – #/definitions/recFeedback description: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/sendRecoveryCode: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – profileType properties: baseInformation: type: string description: profileType: type: string allOf: – #/definitions/profileType description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/checkValidationRecoveryCode: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – validationCodeSent properties: baseInformation: type: string description: validationCodeSent: type: string description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/searchArticle: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – title properties: baseInformation: type: string description: type: string description: bsId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recSearchArticle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/contextSelection: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: message: type: string description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recWattsonReturn 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/responseChat: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: message: type: string description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recWattsonReturn 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/changePasswordADUser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/unlockADUser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: responses: 200: description: Ok schema: type: object required: – baseInformation properties: baseInformation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/workGroupApproval: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – data properties: baseInformation: type: string description: data: type: object allOf: – #/definitions/recWorkGroupApprovalInput description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recWorkGroupApprovalOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/returnADUserInfo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation properties: baseInformation: type: string description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recBaseInformationWithADUserInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/setWorkGroupSenior: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user properties: user: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getSaraAccessToken: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: accessToken: type: string description: responses: 200: description: Ok schema: type: object required: – saraAccess properties: saraAccess: type: object allOf: – #/definitions/recAccess description: default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/createZendeskUser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – zendeskCreateUserInfos properties: baseInformation: type: string description: zendeskCreateUserInfos: type: object allOf: – #/definitions/recZendeskCreateUserInfos description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recBaseInformationMessageEncrypt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/submitZendeskUserToBPM: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – data properties: baseInformation: type: string description: data: type: object allOf: – #/definitions/recSendBpmZendeskInput description: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object allOf: – #/definitions/recBaseInformationMessageEncrypt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/zendeskMasterUserApproval: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – email – erpClientCode properties: name: type: string description: email: type: string description: erpClientCode: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/encryption: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string format: byte description: responses: 200: description: Ok schema: type: object required: – encryptedData properties: encryptedData: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/decryption: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – encryptedData properties: encryptedData: type: string description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: string format: byte description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getClassIndex: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/recGetClassIndex description: default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getCollaboratorInfo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchDocument properties: searchDocument: type: string description: responses: 200: description: Ok schema: type: object properties: data: type: object allOf: – #/definitions/userInfoHcm description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/getCollaboratorDocument: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchEmail properties: searchEmail: type: string description: responses: 200: description: Ok schema: type: object properties: cpf: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/emailSender: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – to – subject – content – html properties: to: type: string description: subject: type: string maxLength: 70 description: content: type: string description: html: type: boolean description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/iaConversation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – conversation properties: baseInformation: type: string description: conversation: type: object allOf: – #/definitions/recIaQuery description: responses: 200: description: Ok schema: type: object required: – baseInformation – queryResponse properties: baseInformation: type: string description: queryResponse: type: object allOf: – #/definitions/recIaQueryResponse description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/iaFeedback: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baseInformation – feedback properties: baseInformation: type: string description: feedback: type: object allOf: – #/definitions/recIaFeedback description: responses: 200: description: Ok schema: type: object required: – baseInformation – message properties: baseInformation: type: string description: message: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/captchaValidator: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: recaptcha: type: string description: default: responses: 200: description: Ok schema: type: object properties: message: type: string description: default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/actions/importInitialAction: 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 /sara_tic_backend/actions/importBotConfiguration: 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 /sara_tic_backend/actions/importInteractionType: 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 /sara_tic_backend/actions/importBotConfigurationInitialAction: 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 /sara_tic_backend/actions/importDialog: 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 /sara_tic_backend/actions/importSession: 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 /sara_tic_backend/actions/importInteraction: 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 /sara_tic_backend/actions/importZendeskProductUser: 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 /sara_tic_backend/actions/importFeedback: 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 /sara_tic_backend/actions/importSupportSystems: 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 /sara_tic_backend/actions/importBotConfigurationSupportSystems: 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 /sara_tic_backend/actions/importSupportSystemsPredefinedPaths: 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 /sara_tic_backend/actions/importRecoveryCode: 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 /sara_tic_backend/events/importInitialActionEvent: 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 /sara_tic_backend/events/exportInitialActionEvent: 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 /sara_tic_backend/events/importBotConfigurationEvent: 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 /sara_tic_backend/events/exportBotConfigurationEvent: 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 /sara_tic_backend/events/importInteractionTypeEvent: 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 /sara_tic_backend/events/exportInteractionTypeEvent: 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 /sara_tic_backend/events/importBotConfigurationInitialActionEvent: 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 /sara_tic_backend/events/exportBotConfigurationInitialActionEvent: 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 /sara_tic_backend/events/importDialogEvent: 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 /sara_tic_backend/events/exportDialogEvent: 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 /sara_tic_backend/events/importSessionEvent: 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 /sara_tic_backend/events/exportSessionEvent: 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 /sara_tic_backend/events/importInteractionEvent: 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 /sara_tic_backend/events/exportInteractionEvent: 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 /sara_tic_backend/events/importZendeskProductUserEvent: 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 /sara_tic_backend/events/exportZendeskProductUserEvent: 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 /sara_tic_backend/events/importFeedbackEvent: 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 /sara_tic_backend/events/exportFeedbackEvent: 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 /sara_tic_backend/events/importSupportSystemsEvent: 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 /sara_tic_backend/events/exportSupportSystemsEvent: 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 /sara_tic_backend/events/importBotConfigurationSupportSystemsEvent: 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 /sara_tic_backend/events/exportBotConfigurationSupportSystemsEvent: 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 /sara_tic_backend/events/importSupportSystemsPredefinedPathsEvent: 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 /sara_tic_backend/events/exportSupportSystemsPredefinedPathsEvent: 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 /sara_tic_backend/events/importRecoveryCodeEvent: 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 /sara_tic_backend/events/exportRecoveryCodeEvent: 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 /sara_tic_backend/entities/initialAction: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/initialAction responses: 200: description: The created resource schema: #/definitions/initialAction 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/initialAction responses: 200: description: The created resource schema: #/definitions/initialAction 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/initialAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/initialAction/{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/editInitialAction responses: 200: description: Ok schema: #/definitions/editInitialAction 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/initialAction responses: 200: description: Ok schema: #/definitions/initialAction 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/initialAction 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 /sara_tic_backend/entities/initialAction/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/initialAction responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/botConfiguration responses: 200: description: The created resource schema: #/definitions/botConfiguration 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/botConfiguration responses: 200: description: The created resource schema: #/definitions/botConfiguration 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/botConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfiguration/{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/editBotConfiguration responses: 200: description: Ok schema: #/definitions/editBotConfiguration 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/botConfiguration responses: 200: description: Ok schema: #/definitions/botConfiguration 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/botConfiguration 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 /sara_tic_backend/entities/botConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/botConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/interactionType: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/interactionType responses: 200: description: The created resource schema: #/definitions/interactionType 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/interactionType responses: 200: description: The created resource schema: #/definitions/interactionType 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/interactionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/interactionType/{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/editInteractionType responses: 200: description: Ok schema: #/definitions/editInteractionType 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/interactionType responses: 200: description: Ok schema: #/definitions/interactionType 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/interactionType 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 /sara_tic_backend/entities/interactionType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/interactionType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfigurationInitialAction: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/botConfigurationInitialAction responses: 200: description: The created resource schema: #/definitions/botConfigurationInitialAction 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/botConfigurationInitialAction responses: 200: description: The created resource schema: #/definitions/botConfigurationInitialAction 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/botConfigurationInitialAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfigurationInitialAction/{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/editBotConfigurationInitialAction responses: 200: description: Ok schema: #/definitions/editBotConfigurationInitialAction 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/botConfigurationInitialAction responses: 200: description: Ok schema: #/definitions/botConfigurationInitialAction 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/botConfigurationInitialAction 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 /sara_tic_backend/entities/botConfigurationInitialAction/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/botConfigurationInitialAction responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/dialog: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dialog responses: 200: description: The created resource schema: #/definitions/dialog 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/dialog responses: 200: description: The created resource schema: #/definitions/dialog 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/dialog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/dialog/{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/editDialog responses: 200: description: Ok schema: #/definitions/editDialog 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/dialog responses: 200: description: Ok schema: #/definitions/dialog 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/dialog 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 /sara_tic_backend/entities/dialog/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dialog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/session: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/session responses: 200: description: The created resource schema: #/definitions/session 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/session responses: 200: description: The created resource schema: #/definitions/session 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/session 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/session/{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/editSession responses: 200: description: Ok schema: #/definitions/editSession 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/session responses: 200: description: Ok schema: #/definitions/session 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/session 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 /sara_tic_backend/entities/session/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/session responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/interaction: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/interaction responses: 200: description: The created resource schema: #/definitions/interaction 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/interaction responses: 200: description: The created resource schema: #/definitions/interaction 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/interaction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/interaction/{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/editInteraction responses: 200: description: Ok schema: #/definitions/editInteraction 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/interaction responses: 200: description: Ok schema: #/definitions/interaction 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/interaction 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 /sara_tic_backend/entities/interaction/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/interaction responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/zendeskProductUser: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/zendeskProductUser responses: 200: description: The created resource schema: #/definitions/zendeskProductUser 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/zendeskProductUser responses: 200: description: The created resource schema: #/definitions/zendeskProductUser 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/zendeskProductUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/zendeskProductUser/{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/editZendeskProductUser responses: 200: description: Ok schema: #/definitions/editZendeskProductUser 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/zendeskProductUser responses: 200: description: Ok schema: #/definitions/zendeskProductUser 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/zendeskProductUser 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 /sara_tic_backend/entities/zendeskProductUser/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/zendeskProductUser responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/feedback: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/feedback responses: 200: description: The created resource schema: #/definitions/feedback 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/feedback responses: 200: description: The created resource schema: #/definitions/feedback 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/feedback 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/feedback/{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/editFeedback responses: 200: description: Ok schema: #/definitions/editFeedback 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/feedback responses: 200: description: Ok schema: #/definitions/feedback 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/feedback 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 /sara_tic_backend/entities/feedback/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/feedback responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/supportSystems: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/supportSystems responses: 200: description: The created resource schema: #/definitions/supportSystems 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/supportSystems responses: 200: description: The created resource schema: #/definitions/supportSystems 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/supportSystems 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/supportSystems/{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/editSupportSystems responses: 200: description: Ok schema: #/definitions/editSupportSystems 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/supportSystems responses: 200: description: Ok schema: #/definitions/supportSystems 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/supportSystems 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 /sara_tic_backend/entities/supportSystems/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/supportSystems responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfigurationSupportSystems: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/botConfigurationSupportSystems responses: 200: description: The created resource schema: #/definitions/botConfigurationSupportSystems 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/botConfigurationSupportSystems responses: 200: description: The created resource schema: #/definitions/botConfigurationSupportSystems 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/botConfigurationSupportSystems 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/botConfigurationSupportSystems/{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/editBotConfigurationSupportSystems responses: 200: description: Ok schema: #/definitions/editBotConfigurationSupportSystems 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/botConfigurationSupportSystems responses: 200: description: Ok schema: #/definitions/botConfigurationSupportSystems 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/botConfigurationSupportSystems 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 /sara_tic_backend/entities/botConfigurationSupportSystems/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/botConfigurationSupportSystems responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/supportSystemsPredefinedPaths: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/supportSystemsPredefinedPaths responses: 200: description: The created resource schema: #/definitions/supportSystemsPredefinedPaths 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/supportSystemsPredefinedPaths responses: 200: description: The created resource schema: #/definitions/supportSystemsPredefinedPaths 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/supportSystemsPredefinedPaths 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/supportSystemsPredefinedPaths/{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/editSupportSystemsPredefinedPaths responses: 200: description: Ok schema: #/definitions/editSupportSystemsPredefinedPaths 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/supportSystemsPredefinedPaths responses: 200: description: Ok schema: #/definitions/supportSystemsPredefinedPaths 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/supportSystemsPredefinedPaths 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 /sara_tic_backend/entities/supportSystemsPredefinedPaths/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/supportSystemsPredefinedPaths responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/recoveryCode: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/recoveryCode responses: 200: description: The created resource schema: #/definitions/recoveryCode 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/recoveryCode responses: 200: description: The created resource schema: #/definitions/recoveryCode 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/recoveryCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sara_tic_backend/entities/recoveryCode/{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/editRecoveryCode responses: 200: description: Ok schema: #/definitions/editRecoveryCode 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/recoveryCode responses: 200: description: Ok schema: #/definitions/recoveryCode 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/recoveryCode 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 /sara_tic_backend/entities/recoveryCode/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/recoveryCode responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: HealthcheckDTO: type: string enum: – UP – DOWN RecoveryDeliveryType: type: string enum: – EMAIL – SMS typeInteraction: type: string enum: – WELCOME – CONVERSATION – CHANGE_PASSWORD – OPEN_TICKET – UNLOCK_USER – START_CONTEXT – FINISH_CONTEXT – CREATE_FEEDBACK – ACTION description: Types of interaction: * `WELCOME` – Welcome interaction * `CONVERSATION` – Conversation interaction * `CHANGE_PASSWORD` – Password change interaction * `OPEN_TICKET` – Ticket creation interaction * `UNLOCK_USER` – User unlock interaction * `START_CONTEXT` – Start context interaction * `FINISH_CONTEXT` – Finish context interaction * `CREATE_FEEDBACK` – Feedback creation interaction * `ACTION` – Action list interaction typeChat: type: string enum: – GPT – WATTSON description: Chat models: * `GPT` – Gpt * `WATTSON` – Wattson profileType: type: string enum: – CONSULTANT – COLLABORATOR – MEGACHANNEL – GENERIC ldapAccountIdentifierType: type: string enum: – MAIL – SAM_ACCOUNT_NAME interactionTags: type: string enum: – DL_SW – IA_CHAT – IA_FB – IA_START – INTERNAL – JIRA_ACC – MENU – OPEN_TKT – PWD_RESET – START – UNLOCK_USR – ZD_USR 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 recEllevoOpenTicketResponse: description: type: object required: – number – status – expirationDate properties: number: type: string description: status: type: string description: expirationDate: type: string description: recEllevoUserInfo: description: type: object required: – applicantId – clientId – userActive properties: applicantId: type: string description: clientId: type: string description: userActive: type: boolean description: recSeverities: description: type: object required: – severityId – severityDescription – severityDefault properties: severityId: type: string description: severityDescription: type: string description: severityDefault: type: string description: recNature: description: type: object required: – natureId – natureDescription – natureDefault – natureDemandsVersion properties: natureId: type: string description: natureDescription: type: string description: natureDefault: type: string description: natureDemandsVersion: type: string description: recPathsInformation: description: type: object required: – productId – processId – moduleId properties: productId: type: string description: Product identifier processId: type: string description: Process identifier moduleId: type: string description: Module identifier recPriorities: description: type: object required: – id – description properties: id: type: string description: description: type: string description: recPaths: description: type: object required: – productId – processId – moduleId – pathId – description – active – idRef properties: productId: type: string description: processId: type: string description: moduleId: type: string description: pathId: type: string description: description: type: string description: active: type: boolean description: idRef: type: string description: recEllevoToken: description: type: object required: – access_token – token_type – expires_in properties: access_token: type: string description: access token token_type: type: string description: token type expires_in: type: integer format: int64 description: expires in recSupportSystemPredefinedPaths: description: type: object required: – name – predefinedPath properties: name: type: string description: Path name predefinedPath: type: object allOf: – #/definitions/recPredefinedPaths description: Path recPredefinedPaths: description: type: object required: – productId – processId – moduleId – searchArticle properties: productId: type: string description: Product identifier processId: type: string description: Process identifier moduleId: type: string description: Path information searchArticle: type: boolean description: Search article status recAccountQuery: description: type: object required: – identifier – identifierType properties: identifier: type: string description: identifierType: type: string allOf: – #/definitions/ldapAccountIdentifierType description: 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 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: mfaCodeValidationRequest: description: type: object properties: email: type: string description: telephone: type: string description: token: type: string description: validationCode: type: string description: deliveryType: type: string allOf: – #/definitions/RecoveryDeliveryType description: recPhoneContact: description: type: object properties: number: type: string description: countryCode: type: string description: phoneContactType: type: string description: localCode: type: string description: recHealthcheckOutput: description: type: object required: – status properties: status: type: string description: recSoftwareInstallation: description: type: object required: – computerName – programName properties: computerName: type: string description: User name programName: type: string description: Download name recSoftwareList: description: Return list of software type: object required: – username – downloadName properties: username: type: string description: Username downloadName: type: string description: Download name recIndexInfo: description: type: object properties: identifier: type: string description: recGenerativeChat: description: type: object required: – source properties: source: type: string description: Type of content sent language: type: string maxLength: 7 description: Query language default: pt_br recIaSession: description: type: object required: – answer – content – connection properties: answer: type: string description: content: type: string description: connection: type: string description: recIndex: description: type: object required: – theme – baseInformation properties: theme: type: string description: initialActions: type: array items: type: object allOf: – #/definitions/initialAction description: baseInformation: type: string description: contexts: type: array items: type: object allOf: – #/definitions/recContext description: iaSession: type: object allOf: – #/definitions/recIaSession description: recDefaultSms: description: type: object required: – to properties: to: type: string description: text: type: string description: recFeedback: description: Return of the home type: object required: – score – comment – interaction properties: score: type: integer format: int64 description: score given by the user comment: type: string description: comment given by the user interaction: type: string description: interaction id recBaseInformationMessageEncrypt: description: type: object required: – baseInformation – message properties: baseInformation: type: string description: message: type: string description: recWattsonReturn: description: type: object required: – baseInformation – message properties: baseInformation: type: string description: Basic Information article: type: array items: type: object allOf: – #/definitions/recSearchArticleEllevoData description: The article message: type: array items: type: object allOf: – #/definitions/recWattsonMessagesReturn minimum: 1 description: Messages recSendBpmZendeskInput: description: type: object required: – name – email – erpClientCode – groupName properties: name: type: string description: email: type: string description: erpClientCode: type: string description: groupName: type: string description: recWattsonMessagesReturn: description: type: object required: – options properties: type: type: string description: options: type: array items: type: object allOf: – #/definitions/recWattsonMessagesOptions minimum: 1 description: message: type: string description: recWattsonMessagesOptions: description: type: object properties: type: string description: description: type: string description: recWorkGroupApprovalInput: description: type: object required: – user – email properties: user: type: string description: email: type: string description: recUserInformation: description: type: object properties: userName: type: string description: email: type: string description: pwdLastSet: type: string description: expiryDate: type: string description: timeLeft: type: integer format: int64 description: status: type: string description: recBaseInformationWithADUserInfo: description: type: object required: – baseInformation – adUserInfo properties: baseInformation: type: string description: adUserInfo: type: object allOf: – #/definitions/recUserInformation description: recWorkGroupApprovalOutput: description: type: object required: – baseInformation – processInstanceID – message properties: baseInformation: type: string description: processInstanceID: type: string description: message: type: string description: recFormData: description: type: object required: – formData – boundary properties: formData: type: string description: boundary: type: string description: recOpenTicketEllevo: description: type: object required: – data properties: data: type: object allOf: – #/definitions/recEllevoData description: files: type: array items: type: object allOf: – #/definitions/recEllevoAttachedFiles description: recEllevoAttachedFiles: description: type: object required: – fileName – mimeType – fileContent properties: fieldName: type: string description: fileName: type: string description: mimeType: type: string description: fileContent: type: string description: recEllevoData: description: type: object properties: productId: type: string description: processId: type: string description: moduleId: type: string description: pathId: type: string description: natureId: type: string description: responsibleId: type: string description: type: string description: description: type: string description: calculateExpiration: type: string description: calculateSla: type: string description: severityId: type: string description: applicantId: type: string description: clientId: type: string description: recInformationEllevo: description: type: object properties: originChatBot: type: string description: recSearchArticle: description: type: object required: – baseInformation – data properties: baseInformation: type: string description: data: type: array items: type: object allOf: – #/definitions/recSearchArticleEllevoData minimum: 1 description: recSearchArticleEllevoData: description: type: object required: – bsId – title properties: bsId: type: string description: type: string description: guId: type: string description: proId: type: string description: procId: type: string description: pathId: type: string description: problem: type: string description: answer: type: string description: recUserInfo: description: User index Record type: object properties: fullName: type: string description: Full name email: type: string description: email tenantDomain: type: string description: First name tenantName: type: string description: Last name photo: type: string description: User photo recArtificialIntelligence: description: type: object required: – aiIdentifier – name properties: aiIdentifier: type: string description: name: type: string description: recResponseChat: description: type: object required: – baseInformation – article – response properties: baseInformation: type: string description: article: type: array items: type: object allOf: – #/definitions/recArticles minimum: 1 description: response: type: array items: type: object allOf: – #/definitions/recResponses minimum: 1 description: recContext: description: type: object required: – contextIdentifier properties: contextIdentifier: type: string description: name: type: string description: description: type: string description: recArticles: description: type: object required: – message – html – url properties: message: type: string description: html: type: string description: url: type: string description: recResponses: description: type: object required: – type – content – context properties: type: type: string description: content: type: string description: context: type: array items: type: object allOf: – #/definitions/recContext minimum: 1 description: recAccess: description: type: object required: – accessToken – userType properties: accessToken: type: string description: userType: type: string description: recZendeskCreateUserInfos: description: type: object required: – name – email – typeUser properties: name: type: string description: email: type: string description: erpClientCode: type: string description: typeUser: type: string description: recBaseInformation: description: type: object required: – identifier – aiIdentifier – dialog – session – interaction properties: identifier: type: string description: aiIdentifier: type: string description: dialog: type: string description: session: type: string description: interaction: type: string description: isSession: type: boolean description: default: false context: type: object allOf: – #/definitions/recContext description: password: type: object allOf: – #/definitions/recPassword description: mfaCodeValidation: type: string description: softwareListLock: type: string description: accountToUpdate: type: string description: accountInformation: type: string description: basicInformation: type: object allOf: – #/definitions/recBasicInformation description: recGetClassIndex: description: type: object required: – code – path properties: code: type: string description: path: type: string description: recEmail: description: type: object required: – email – type properties: email: type: string description: email type: type: string description: type recTelephone: description: type: object required: – telephone – type properties: telephone: type: string description: telephone type: type: string description: type userInfoHcm: description: type: object required: – id – firstname – middleName – lastname – fullName – nickname – birthday – cpf – maritalStatus – race – telephone – email properties: id: type: string description: firstname: type: string description: middleName: type: string description: lastname: type: string description: fullName: type: string description: nickname: type: string description: birthday: type: string description: cpf: type: string description: maritalStatus: type: string description: race: type: string description: telephone: type: array items: type: object allOf: – #/definitions/recTelephone minimum: 1 description: email: type: array items: type: object allOf: – #/definitions/recEmail minimum: 1 description: service: description: type: object required: – domain – service properties: domain: type: string description: service: type: string description: attachment: description: type: object required: – name – url properties: name: type: string description: url: type: string description: body: description: type: object properties: html: type: string description: text: type: string description: content: description: type: object required: – body – subject properties: body: type: object allOf: – #/definitions/body description: subject: type: string description: attachments: type: array items: type: object allOf: – #/definitions/attachment description: destination: description: type: object required: – to properties: to: type: array items: type: string minimum: 1 description: cc: type: array items: type: string description: bcc: type: array items: type: string description: recEmailLayout: description: type: object required: – content – destination properties: content: type: object allOf: – #/definitions/content description: Email content source: type: string description: Source email address for sending destination: type: object allOf: – #/definitions/destination description: Destination for sending email origin: type: object allOf: – #/definitions/service description: If provided, the email configuration for this origin will be used validate: type: boolean description: Indicates whether the message should be validated synchronously default: false recBasicInformation: description: type: object properties: email: type: string description: User email address phone: type: string description: User phone number recPassword: description: type: object properties: newPassword: type: string description: New password provided by the user confirmPassword: type: string description: Confirmation of the new password recIaQuery: description: type: object required: – connection – source properties: connection: type: string description: Chat Connection hash query: type: string description: Question for the AI default: source: type: string description: Type of content sent language: type: string maxLength: 7 description: Query language default: pt_br recIaQueryResponseLink: description: type: object required: – link properties: link: type: string maxLength: 512 description: Link to the related content recIaQueryResponseTitle: description: type: object required: – title properties: type: string maxLength: 256 description: Title to the related content links recIaQueryResponse: description: Standard response returned by the AI query type: object required: – message_id properties: response: type: string description: Textual response generated by the AI links: type: array items: type: object allOf: – #/definitions/recIaQueryResponseLink description: List of related content links titles: type: array items: type: object allOf: – #/definitions/recIaQueryResponseTitle description: Titles corresponding to the returned links domain: type: string description: Domain or product area related to the query message_id: type: string description: Unique identifier for the generated message recIaFeedback: description: type: object required: – message_id properties: message_id: type: string description: Unique identifier for the generated message rating: type: integer format: int64 description: Feedback rating minimum: -1 maximum: 1 default: 1 initialAction: description: Initial bot action configuration type: object required: – componentCall – quest – icon properties: id: type: string format: uuid description: Unique identifier componentCall: type: string description: Component call reference quest: type: string description: Question displayed to the user icon: type: string description: Icon identifier level: type: integer format: int64 description: Display order level onlyLogon: type: boolean description: Indicates if the action is only for logged-in users default: true createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editInitialAction: type: object required: – id allOf: – #/definitions/initialAction botConfiguration: description: Bot configuration type: object required: – identifier properties: id: type: string format: uuid description: Unique identifier identifier: type: string description: Bot configuration identifier createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editBotConfiguration: type: object required: – id allOf: – #/definitions/botConfiguration interactionType: description: Interaction type classification type: object required: – identifier properties: id: type: string format: uuid description: Unique identifier identifier: type: string description: Interaction type identifier createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editInteractionType: type: object required: – id allOf: – #/definitions/interactionType botConfigurationInitialAction: description: Association between bot configuration and initial action type: object required: – botConfigurationId – initialActionId properties: id: type: string format: uuid description: Unique identifier botConfigurationId: type: string format: uuid description: Associated bot configuration initialActionId: type: string format: uuid description: Associated initial action createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editBotConfigurationInitialAction: type: object required: – id allOf: – #/definitions/botConfigurationInitialAction dialog: description: Conversation dialog between user and bot type: object required: – botConfigurationId – userLogin properties: id: type: string format: uuid description: Unique identifier botConfigurationId: type: string format: uuid description: Associated bot configuration userLogin: type: string description: User login createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editDialog: type: object required: – id allOf: – #/definitions/dialog session: description: Conversation session within a dialog type: object required: – dialogId properties: id: type: string format: uuid description: Unique identifier dialogId: type: string format: uuid description: Associated dialog createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editSession: type: object required: – id allOf: – #/definitions/session interaction: description: Single interaction within a session type: object required: – sessionId – interactionTypeId properties: id: type: string format: uuid description: Unique identifier sessionId: type: string format: uuid description: Associated session interactionTypeId: type: string format: uuid description: Interaction type reference initialActionId: type: string format: uuid description: Context (initial action) that triggered this interaction input: type: string description: User input text output: type: string description: System output text confidence: type: number format: double description: Response confidence level createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editInteraction: type: object required: – id allOf: – #/definitions/interaction zendeskProductUser: description: Zendesk product user association type: object required: – productName – groupName properties: id: type: string format: uuid description: Unique identifier productName: type: string description: Product name groupName: type: string description: Group name createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editZendeskProductUser: type: object required: – id allOf: – #/definitions/zendeskProductUser feedback: description: User feedback on an interaction type: object required: – interactionId – score – comment properties: id: type: string format: uuid description: Unique identifier interactionId: type: string format: uuid description: Associated interaction score: type: number format: double description: Feedback score comment: type: string description: Feedback comment createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editFeedback: type: object required: – id allOf: – #/definitions/feedback supportSystems: description: Support system configuration type: object required: – identifier properties: id: type: string format: uuid description: Unique identifier identifier: type: string description: Support system identifier createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editSupportSystems: type: object required: – id allOf: – #/definitions/supportSystems botConfigurationSupportSystems: description: Association between bot configuration and support system type: object required: – botConfigurationId – supportSystemId – active properties: id: type: string format: uuid description: Unique identifier botConfigurationId: type: string format: uuid description: Associated bot configuration supportSystemId: type: string format: uuid description: Associated support system active: type: boolean description: Indicates if the support system is active createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editBotConfigurationSupportSystems: type: object required: – id allOf: – #/definitions/botConfigurationSupportSystems supportSystemsPredefinedPaths: description: Predefined paths for support system bot configuration type: object required: – botConfigurationSupportSystemsId – name – predefinedPath – active properties: id: type: string format: uuid description: Unique identifier botConfigurationSupportSystemsId: type: string format: uuid description: Associated bot configuration support system name: type: string description: Path name predefinedPath: type: string description: Predefined path value active: type: boolean description: Indicates if the path is active createdBy: type: string maxLength: 150 description: User who created the record createdAt: type: string format: date-time description: Record creation date lastModifiedBy: type: string maxLength: 150 description: User who last modified the record lastModifiedAt: type: string format: date-time description: Last modification date editSupportSystemsPredefinedPaths: type: object required: – id allOf: – #/definitions/supportSystemsPredefinedPaths recoveryCode: description: Recovery code for password reset and validation type: object required: – deliveryType – verificationCode – expirationDate properties: id: type: string format: uuid description: Unique identifier username: type: string maxLength: 150 description: User identifier phoneNumber: type: string maxLength: 20 description: User phone number email: type: string maxLength: 255 description: User email address deliveryType: type: string allOf: – #/definitions/RecoveryDeliveryType description: Delivery type for the recovery code verificationCode: type: integer format: int64 description: Verification code sent to the user minimum: 100000 maximum: 999999 expirationDate: type: string format: date-time description: Code expiration date retryExceptions: type: integer format: int64 description: Number of retry exceptions minimum: 0 maximum: 10 default: 0 rateLimit: type: integer format: int64 description: Rate limit for code generation minimum: 1 maximum: 10 default: 3 isValid: type: boolean description: Indicates if the code is still valid default: true editRecoveryCode: type: object required: – id allOf: – #/definitions/recoveryCode notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage