Gestão de Pessoas (hcm)

profileassessments

56 views 15/04/2020 24/11/2020 integrador 0

2.0info: 2.1.1 profileassessments description: Serviço de testes de perfil e lógica do Gestão de Recrutamento e Seleção x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: profileassessments 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/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /profileassessments/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/getProfileassessmentsConfiguration: post: description: Expõe a configuração solicitada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: configurations: type: array items: type: string allOf: – #/definitions/defaultConfiguration description: Configuração que se deseja verificar o seu valor. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configuration minimum: 1 description: Valores das configurações. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/getWebhooksConfiguration: post: description: Obtém o status de criação de cada Webhook da Mindsight tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/configurationStatusWebhook description: Status de todos os Webhooks 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o status de criação de cada Webhook da Mindsight tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/configurationStatusWebhook description: Status de todos os Webhooks 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/getAssessmentsByContext: post: description: Busca os testes que devem ser mostrados no contexto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – assessmentContext properties: assessmentContext: type: string allOf: – #/definitions/context description: Contexto da requisição hasAnyFunction: type: boolean description: Indica se tem função no contexto responses: 200: description: Ok schema: type: object required: – assessments properties: assessments: type: array items: type: object allOf: – #/definitions/test minimum: 1 description: Valores das configurações. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/candidateTestResult: post: description: Retorna os resultados consolidados dos resultados dos testes do candidato de uma dada função.\n Caso não seja passada uma função retorna os resultados sem funções. Também considera o contexto do teste,\n caso não seja passado um, traz todos os resultados do candidato. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidate properties: candidate: type: string description: Identificador interno do candidato no serviço vacancymanagement. vacancy: type: string description: Identificador interno da vaga no serviço vacancymanagement. assessmentContext: type: string allOf: – #/definitions/context description: Contexto da requisição. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/candidateTestResultInfo minimum: 1 description: Valores dos resultados dos testes do candidato, agrupados pelos testes. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/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 /profileassessments/queries/exportConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportReceivedEvents: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportFunction: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportVacancy: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportCandidate: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportVacancySubscription: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportTest: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportTestResult: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/exportLink: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/createDefaultConfiguration: post: description: Cria as configurações padrões da aplicação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hasProfileAssessments properties: hasProfileAssessments: type: boolean description: Indica se o tenant possui testes de perfil hasMindsightIntegration: type: boolean description: Indica se o tenant possui integração com Mindsight default: false mindsightIntegrationUrl: type: string description: URL base utilizada para chamadas de API para Mindsight mindsightIntegrationToken: type: string description: Token que deve ser utilizado nas chamadas feitas para APIs da Mindsight hasOcpAssessment: type: boolean description: Indica se tem teste de cultura default: false hasMatchAssessment: type: boolean description: Indica se tem teste de match default: false responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/configuration minimum: 1 description: Configurações que foram criadas no banco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/validateMindsightIntegrationToken: post: description: Faz a validação do Token para a integração com a Mindsight tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – url – token properties: url: type: string description: URL base para validar o token token: type: string description: Token a ser validado responses: 200: description: Ok schema: type: object required: – validated properties: validated: type: boolean description: Flag que indica se o token foi validado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/createTalentPoolVacancy: post: description: Cria a vaga de banco de talentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – talentPoolVacancy properties: talentPoolVacancy: type: string description: O id da vaga criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/getFunctions: post: description: Carrega as funções salvas na base da Mindsight para a base do Profile Assessments tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/function minimum: 1 description: As funções da Mindsight 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/getCandidateTestLinks: post: description: Busca os links dos testes ligados ao candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidate properties: candidate: type: object allOf: – #/definitions/candidate description: Identificador do candidato vacancy: type: object allOf: – #/definitions/vacancy description: Vaga para buscar os testes testId: type: string description: Teste para buscar os links recruitmentProcessId: type: string description: Identificador do processo no vacancy responses: 200: description: Ok schema: type: object required: – links properties: links: type: array items: type: object allOf: – #/definitions/link minimum: 1 description: Links dos testes de acordo com os parâmetros informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/signMindsightWebhooks: post: description: Assina os webhooks da Mindsight passados pelo usuário. Caso nenhum seja passado por parâmetro, tentará assinar todos os webhooks que ainda não foram assinados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: webhooks: type: array items: type: string allOf: – #/definitions/mindsightWebhookType description: Tipo de webhook para assinar. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importReceivedEvents: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importFunction: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importVacancy: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importCandidate: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importVacancySubscription: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importTest: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importTestResult: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/actions/importLink: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/configuration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuration responses: 200: description: The created resource schema: #/definitions/configuration 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/configuration responses: 200: description: The created resource schema: #/definitions/configuration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configuration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/configuration/{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/configuration responses: 200: description: Ok schema: #/definitions/configuration 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/configuration responses: 200: description: Ok schema: #/definitions/configuration 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/configuration 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 /profileassessments/entities/configuration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/receivedEvents: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/receivedEvents responses: 200: description: The created resource schema: #/definitions/receivedEvents 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/receivedEvents responses: 200: description: The created resource schema: #/definitions/receivedEvents 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/receivedEvents 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/receivedEvents/{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/receivedEvents responses: 200: description: Ok schema: #/definitions/receivedEvents 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/receivedEvents responses: 200: description: Ok schema: #/definitions/receivedEvents 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/receivedEvents 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 /profileassessments/entities/receivedEvents/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivedEvents responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/function: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/function responses: 200: description: The created resource schema: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/function responses: 200: description: The created resource schema: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/function/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/function responses: 200: description: Ok schema: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/function responses: 200: description: Ok schema: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /profileassessments/entities/function/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/function responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/vacancy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacancy responses: 200: description: The created resource schema: #/definitions/vacancy 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/vacancy responses: 200: description: The created resource schema: #/definitions/vacancy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacancy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/vacancy/{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/vacancy responses: 200: description: Ok schema: #/definitions/vacancy 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/vacancy responses: 200: description: Ok schema: #/definitions/vacancy 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/vacancy 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 /profileassessments/entities/vacancy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacancy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/candidate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/candidate responses: 200: description: The created resource schema: #/definitions/candidate 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/candidate responses: 200: description: The created resource schema: #/definitions/candidate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/candidate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/candidate/{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/candidate responses: 200: description: Ok schema: #/definitions/candidate 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/candidate responses: 200: description: Ok schema: #/definitions/candidate 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/candidate 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 /profileassessments/entities/candidate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/candidate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/vacancySubscription: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacancySubscription responses: 200: description: The created resource schema: #/definitions/vacancySubscription 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/vacancySubscription responses: 200: description: The created resource schema: #/definitions/vacancySubscription 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacancySubscription 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/vacancySubscription/{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/vacancySubscription responses: 200: description: Ok schema: #/definitions/vacancySubscription 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/vacancySubscription responses: 200: description: Ok schema: #/definitions/vacancySubscription 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/vacancySubscription 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 /profileassessments/entities/vacancySubscription/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacancySubscription responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/test: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/test responses: 200: description: The created resource schema: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/test responses: 200: description: The created resource schema: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/test/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/test responses: 200: description: Ok schema: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/test responses: 200: description: Ok schema: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/test 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /profileassessments/entities/test/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/test responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/testResult: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/testResult responses: 200: description: The created resource schema: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/testResult responses: 200: description: The created resource schema: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/testResult/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/testResult responses: 200: description: Ok schema: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/testResult responses: 200: description: Ok schema: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/testResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /profileassessments/entities/testResult/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/testResult responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/link: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/link responses: 200: description: The created resource schema: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/link responses: 200: description: The created resource schema: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /profileassessments/entities/link/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/link responses: 200: description: Ok schema: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/link responses: 200: description: Ok schema: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/link 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /profileassessments/entities/link/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/link responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN context: description: Contexto da requisição type: string enum: – TALENT_POOL – VACANCY_MANAGEMENT – KANBAN eventStatus: description: Status de evento recebido type: string enum: – ERROR – SUCCESS defaultConfiguration: description: Configurações usadas internamente pelo serviço type: string enum: – HAS_PROFILE_ASSESSMENTS – HAS_MINDSIGHT_INTEGRATION – MINDSIGHT_INTEGRATION_URL – MINDSIGHT_INTEGRATION_TOKEN – HAS_OCP_ASSESSMENT – HAS_MATCH_ASSESSMENT – TALENT_POOL_VACANCY – SECRET_LOGIC_UPDATED – SECRET_OCP_UPDATED – SECRET_SJT_UPDATED – SECRET_MOTIVATIONAL_UPDATED – SECRET_MATCH_UPDATED – SECRET_PROFILEMAP_UPDATED situationType: description: Situações da vaga. type: string enum: – IN_PROGRESS – SUSPENDED – CANCELED – FINALIZED reasonType: description: Motivo de abertura da vaga. type: string enum: – STAFF_INCREASE – REPLACEMENT mindsightWebhookType: description: Tipo de webhook da Mindsight. type: string enum: – LOGIC – OCP – SJT – MOTIVATIONAL – MATCH – PROFILEMAP webhookStatus: description: Status de criação do webhook na Mindsight. type: string enum: – PENDING – SUCCESS – ERROR userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status configurationStatusWebhook: description: Status de configuração do Webhook na Mindsight type: object required: – webhook – status properties: webhook: type: string allOf: – #/definitions/mindsightWebhookType description: Nome do webhook status: type: string allOf: – #/definitions/webhookStatus description: Status de criação testResultInfo: description: Informações dos resultados dos testes. type: object properties: id: type: string description: Identificador do resultado do teste. score: type: number format: double description: Nota resultExpired: type: boolean description: Flag que indica se o resultado está expirado candidateTestResultInfo: description: Informações dos resultados dos testes agrupados pelos testes. type: object required: – name properties: id: type: string description: Identificador do teste. name: type: string maxLength: 255 description: Nome do teste. presentationOrder: type: integer format: int64 description: Ordem de apresentação do teste. level: type: integer format: int64 description: Nível do teste na estrutura de testes color: type: string maxLength: 255 description: Armazenará o código hexadecimal da cor do teste icon: type: string maxLength: 255 description: Armazenará o código do ícone do teste result: type: object allOf: – #/definitions/testResultInfo description: Resultado do teste. details: type: array items: type: object allOf: – #/definitions/candidateTestResultInfo description: Detalhes do teste. configuration: description: Configurações type: object required: – key – value properties: id: type: string format: uuid description: Id key: type: string maxLength: 255 description: Chave da configuração value: type: string maxLength: 500 description: Valor da configuração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: receivedEvents: description: Auditoria de eventos recebidos type: object required: – endpoint – dateWhen – status – requestId properties: id: type: string format: uuid description: Id endpoint: type: string maxLength: 255 description: Endpoint que o evento foi recebido dateWhen: type: string format: date-time description: Data de recebimento inputJson: type: string maxLength: 5000 description: JSON de entrada outputJson: type: string maxLength: 5000 description: JSON de saída status: type: string allOf: – #/definitions/eventStatus description: Status do evento requestId: type: string maxLength: 255 description: Id da request da plataforma createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: function: description: Função type: object required: – name properties: id: type: string format: uuid description: Id externalId: type: string maxLength: 255 description: Id no serviço de testes name: type: string maxLength: 255 description: Nome da função x-i18n: true vacancies: type: array items: type: object allOf: – #/definitions/vacancy description: Vagas associadas a função testResults: type: array items: type: object allOf: – #/definitions/testResult description: Resultado dos testes ligados a função createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. vacancy: description: Vaga type: object required: – internalId – situation – reason properties: id: type: string format: uuid description: Id internalId: type: string format: uuid description: Id no vacancymanagement externalId: type: string maxLength: 255 description: Id no serviço de testes function: type: object allOf: – #/definitions/function description: Função relacionada a vaga type: string maxLength: 255 description: Título da vaga situation: type: string allOf: – #/definitions/situationType description: Situação da vaga reason: type: string allOf: – #/definitions/reasonType description: Motivo de abertura da vaga vacancySubscriptions: type: array items: type: object allOf: – #/definitions/vacancySubscription description: Inscrições na vaga links: type: array items: type: object allOf: – #/definitions/link description: Links dos testes da vaga createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: candidate: description: Candidato type: object required: – internalId – name – email properties: id: type: string format: uuid description: Id internalId: type: string format: uuid description: Id no vacancymanagement externalId: type: string maxLength: 255 description: Id no serviço de testes name: type: string maxLength: 255 description: Nome. email: type: string maxLength: 255 description: E-mail. cpf: type: string maxLength: 11 description: CPF. vacancySubscriptions: type: array items: type: object allOf: – #/definitions/vacancySubscription description: Inscrições do candidato testResults: type: array items: type: object allOf: – #/definitions/testResult description: Resultado dos testes ligados ao candidato links: type: array items: type: object allOf: – #/definitions/link description: Links dos testes do candidato ignoreIntegration: type: boolean description: Indica se o registro será integrado com a Mindsight default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacancySubscription: description: Inscrições nas vagas type: object required: – candidate properties: id: type: string format: uuid description: Id internalId: type: string format: uuid description: Id da RecruitmentProcess no vacancy externalId: type: string maxLength: 255 description: Id no serviço de testes vacancy: type: object allOf: – #/definitions/vacancy description: Vaga da inscrição candidate: type: object allOf: – #/definitions/candidate description: Candidato da inscrição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: test: description: Testes type: object required: – name – presentationOrder – level properties: id: type: string format: uuid description: Id externalId: type: string maxLength: 255 description: Id no serviço de testes name: type: string maxLength: 255 description: Nome x-i18n: true parent: type: object allOf: – #/definitions/test description: Teste pai presentationOrder: type: integer format: int64 description: Ordem de apresentação showInTalentPool: type: boolean description: Flag que indica se a nota do teste é mostrada no banco de talentos default: false showInManageVacancy: type: boolean description: Flag que indica se a nota do teste é mostrada no gerenciamento da vaga default: false showInKanban: type: boolean description: Flag que indica se a nota do teste é mostrada no kanban default: false showOnlyWithFunction: type: boolean description: Indica se o teste deve ser apresentado somente quando tiver uma função no contexto default: false type: type: string maxLength: 255 description: Tipo do teste description: type: string maxLength: 255 description: Descrição do teste x-i18n: true level: type: integer format: int64 description: Nível do teste na estrutura de testes maximum: 3 color: type: string maxLength: 255 description: Armazenará o código hexadecimal da cor do teste icon: type: string maxLength: 255 description: Armazenará o código do ícone do teste testResults: type: array items: type: object allOf: – #/definitions/testResult description: Resultados dos testes readOnly: true links: type: array items: type: object allOf: – #/definitions/link description: Links para o teste createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 description: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR.description: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale.description: Text example using en-US locale. testResult: description: Resultados dos testes type: object required: – candidate – test properties: id: type: string format: uuid description: Id externalId: type: string maxLength: 255 description: Id no serviço de resultados dos testes candidate: type: object allOf: – #/definitions/candidate description: Candidato do teste function: type: object allOf: – #/definitions/function description: Função do teste test: type: object allOf: – #/definitions/test description: Teste referente ao resultado score: type: number format: double description: Nota minimum: 0 maximum: 100 additionalInformation: type: string maxLength: 5000 description: Complemento da nota x-i18n: true resultExpired: type: boolean description: Flag que indica se o resultado está expirado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: additionalInformation: type: string maxLength: 5000 example: pt-BR: additionalInformation: Exemplo de texto usando locale pt-BR. en-US: additionalInformation: Text example using en-US locale. link: description: Links dos testes type: object required: – link – test properties: id: type: string format: uuid description: Id link: type: string maxLength: 1000 description: Link vacancy: type: object allOf: – #/definitions/vacancy description: Vaga label: type: string maxLength: 255 description: Label do link no email enviado ao candidato x-i18n: true mindsightResourceUrl: type: string maxLength: 255 description: URL do recurso da mindsight test: type: object allOf: – #/definitions/test description: Teste candidate: type: object allOf: – #/definitions/candidate description: Candidato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: label: type: string maxLength: 255 example: pt-BR: label: Exemplo de texto usando locale pt-BR. en-US: label: Text example using en-US locale. notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment