2.0info: 2.0.1 Serviço de questionários do HCM. /bridge/rest/hcm – application/json – application/jsonpaths: /question_service/queries/questionnaireUserAnswers: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – username properties: questionnaireId: type: string description: Identificador do questionário. username: type: string description: Nome de usuário responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaire default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries parameters: – name: questionnaireId in: query required: true type: string – name: username in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaire default: description: Error response schema: #/definitions/genericError /question_service/queries/questionnaireAnswersById: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – answerId properties: answerId: type: string description: Identificador da resposta. responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaire default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries parameters: – name: answerId in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaire default: description: Error response schema: #/definitions/genericError /question_service/queries/getMostRecentDomainServiceQuestionnaire: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna o questionário mais recente de um domínio/serviço. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio. serviceName: type: string description: Serviço. responses: 200: description: Ok schema: type: object required: – questionnaires properties: questionnaires: type: array items: type: object allOf: – #/definitions/questionnaire minimum: 1 description: Id do questionário. default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna o questionário mais recente de um domínio/serviço. tags: – Queries parameters: – name: domainName in: query required: true type: string – name: serviceName in: query required: true type: string responses: 200: description: Ok schema: type: object required: – questionnaires properties: questionnaires: type: array items: type: object allOf: – #/definitions/questionnaire minimum: 1 description: Id do questionário. default: description: Error response schema: #/definitions/genericError /question_service/queries/listUsersThatAnsweredQuestionnaire: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista os usuários que responderam a determinado questionário. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – questionnaireId properties: questionnaireId: type: string description: Identificador do questionário. responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Lista de usuários. default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista os usuários que responderam a determinado questionário. tags: – Queries parameters: – name: questionnaireId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Lista de usuários. default: description: Error response schema: #/definitions/genericError /question_service/queries/getMetadata: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries parameters: – name: metadataFormat in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /question_service/queries/getDependencies: post: description: This operation is public. Returns a list with all dependencies from this service, along with their respective versions tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: This operation is public. Returns a list with all dependencies from this service, along with their respective versions tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaire: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Reponde as perguntas. tags: – Actions parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/questionnaireAnswers responses: 200: description: Ok schema: type: object required: – answerId properties: answerId: type: string description: Id da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaireAnonymous: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Reponde as perguntas de forma anonima. tags: – Actions parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/questionnaireAnswersAnonymous responses: 200: description: Ok schema: type: object required: – answerId properties: answerId: type: string description: Id da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaireByOther: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Reponde as perguntas por outra pessoa. tags: – Actions parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/questionnaireAnswersByOther responses: 200: description: Ok schema: type: object required: – answerId properties: answerId: type: string description: Id da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/entities/answeredAlternative: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/answeredAlternative responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/answeredAlternative responses: 200: description: The created resource schema: #/definitions/answeredAlternative default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/answeredAlternative default: description: Error response schema: #/definitions/genericError /question_service/entities/answeredAlternative/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/answeredAlternative responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/answeredAlternative responses: 200: description: Ok schema: #/definitions/answeredAlternative default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/answeredAlternative default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/questionnaire: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/questionnaire responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/questionnaire responses: 200: description: The created resource schema: #/definitions/questionnaire default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/questionnaire default: description: Error response schema: #/definitions/genericError /question_service/entities/questionnaire/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionnaire responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionnaire responses: 200: description: Ok schema: #/definitions/questionnaire default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/questionnaire default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/question: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/question responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/question responses: 200: description: The created resource schema: #/definitions/question default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/question default: description: Error response schema: #/definitions/genericError /question_service/entities/question/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/question responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/question responses: 200: description: Ok schema: #/definitions/question default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/question default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/alternative: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/alternative responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/alternative responses: 200: description: The created resource schema: #/definitions/alternative default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/alternative default: description: Error response schema: #/definitions/genericError /question_service/entities/alternative/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/alternative responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/alternative responses: 200: description: Ok schema: #/definitions/alternative default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/alternative default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/answer: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/answer responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/answer responses: 200: description: The created resource schema: #/definitions/answer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/answer default: description: Error response schema: #/definitions/genericError /question_service/entities/answer/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/answer responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/answer responses: 200: description: Ok schema: #/definitions/answer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/answer default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/textAnswer: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/textAnswer responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/textAnswer responses: 200: description: The created resource schema: #/definitions/textAnswer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/textAnswer default: description: Error response schema: #/definitions/genericError /question_service/entities/textAnswer/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/textAnswer responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/textAnswer responses: 200: description: Ok schema: #/definitions/textAnswer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/textAnswer default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /question_service/entities/levelAnswer: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/levelAnswer responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/levelAnswer responses: 200: description: The created resource schema: #/definitions/levelAnswer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/levelAnswer default: description: Error response schema: #/definitions/genericError /question_service/entities/levelAnswer/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/levelAnswer responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/levelAnswer responses: 200: description: Ok schema: #/definitions/levelAnswer default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/levelAnswer default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError definitions: questionTypeDto: description: Tipos aceitos de alternativas de questões type: string enum: – CHECKBOX – RADIO – TEXT – LEVEL 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 answeredQuestionnaire: description: Respostas de um questionário type: object required: – id – questions properties: id: type: string description: Identificador do questionário questions: type: array items: type: object allOf: – #/definitions/answeredQuestions minimum: 1 description: Questões com respostas. answeredQuestions: description: Questões com respostas. type: object required: – id – description – type – sequence – text – level properties: id: type: string description: Identificador da questão description: type: string description: Descrição da questão. type: type: string allOf: – #/definitions/questionTypeDto description: Tipo da questão. sequence: type: integer format: int64 description: Sequencia em que essa questão deve ser aprensentada. alternatives: type: array items: type: object allOf: – #/definitions/answeredAlternative description: Alternativas dessa questão. text: type: string description: Texto respondido quando do tipo TEXT. level: type: integer format: int64 description: Resposta de nível, se for o caso. answeredAlternative: description: Alternativas das questões. type: object required: – id – description – sequence – checked properties: id: type: string description: Identificador da alternativa description: type: string description: Descrição da alternativa. sequence: type: integer format: int64 description: Sequencia em que essa alternativa deve ser aprensentada. checked: type: boolean description: Indica que a alternativa foi selecionada. Quando do tipo RADIO ou CHECKBOX questionnaireAnswers: description: Questões respondidas do questionário. type: object required: – questionnaireId – answers properties: questionnaireId: type: string description: Identificador único do questionário. answers: type: array items: type: object allOf: – #/definitions/questionAnswer minimum: 1 description: Nome do usuário dessa resposta questionnaireAnswersByOther: description: Questes respondidas do questionário. type: object required: – questionnaireId – username – answers properties: questionnaireId: type: string description: Identificador único do questionário. username: type: string description: Nome do usuário dessa resposta answers: type: array items: type: object allOf: – #/definitions/questionAnswer minimum: 1 description: Questões desse questionário. questionnaireAnswersAnonymous: description: Questões respondidas do questionário. type: object required: – questionnaireId – anonymousHash – answers properties: questionnaireId: type: string description: Identificador único do questionário. anonymousHash: type: string description: Hash uníca dessa resposta. answers: type: array items: type: object allOf: – #/definitions/questionAnswer minimum: 1 description: Questões desse questionário. questionAnswer: description: Resposta da questão. type: object required: – questionId properties: questionId: type: string description: Identificador único do questão. alternativesId: type: array items: type: string description: Identificador único da alternativa selecionada(Quando for questão de alternativas). text: type: string description: Texto da resposta(Quando for questão de texto livre). level: type: integer format: int64 description: Resposta quando do tipo nível. minimum: 0 maximum: 10 questionnaire: description: Questionário. type: object required: – title – domainName – serviceName properties: id: type: string description: Identificador único da entidade. type: string description: Titulo do questionário. domainName: type: string description: Nome do domínio que está usando esse questionário. serviceName: type: string description: Nome do serviço que está utilizando esse questionário. questions: type: array items: type: object allOf: – #/definitions/question description: Questões desse questionário. createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. hasResponse: type: boolean description: Indica que o questionário já possui respostas. question: description: Questões do questionário. type: object required: – description – type – required – sequence properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da questão. type: type: string allOf: – #/definitions/questionTypeDto description: Tipo da questão. required: type: boolean description: Indica se a questão é obrigatória. sequence: type: integer format: int64 description: Sequencia em que essa questão deve ser aprensentada. alternatives: type: array items: type: object allOf: – #/definitions/alternative description: Alternativas dessa questão. createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. alternative: description: Alternativas das questões. type: object required: – description – sequence properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da alternativa. questionId: type: string description: Identificador da questão à qual essa alternativa está associada. sequence: type: integer format: int64 description: Sequencia em que essa alternativa deve ser aprensentada. createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. answer: description: Resposta de um questionário. type: object required: – questionnaireId – anonymous properties: id: type: string description: Identificador único da entidade. questionnaireId: type: string description: Identificador único do questionário. anonymous: type: boolean description: Indica que a resposta é anônima. username: type: string description: Nome de usuário do usuário que respondeu. alternatives: type: array items: type: object allOf: – #/definitions/alternative description: Alternativas selecionadas pelo candidato. textAnswers: type: array items: type: object allOf: – #/definitions/textAnswer description: Respostas de questões de texto livre. levelAnswers: type: array items: type: object allOf: – #/definitions/levelAnswer description: Respostas de questões com nivel. creator: type: string description: Usuário que criou essa resposta. createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. textAnswer: description: Resposta de text livre da questão. type: object required: – questionId properties: questionId: type: string description: Identificador único do questão. text: type: string description: Texto da resposta(Quando for questão de texto livre). createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. levelAnswer: description: Resposta de questão com nivel. type: object required: – questionId properties: questionId: type: string description: Identificador único do questão. level: type: integer format: int64 description: Nivel selecionado. createdat: type: string format: date-time description: Data e hora de criação. updatedAt: type: string format: date-time description: Data e hora de alteração. notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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. 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