Hcm

question_service

10 views 20/09/2019 18/11/2019 integrador 0

2.0info: 3.2.0 question_service description: Serviço de questionários do HCM. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: question_service contact: name: Senior X Platform url: http://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: /question_service/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados default: description: Error response schema: #/definitions/genericError /question_service/queries/questionnaireUserAnswers: post: description: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE 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: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: questionnaireId description: Identificador do questionário. in: query required: true type: string – name: username description: Nome de usuário. 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: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE 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: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: answerId description: Identificador da resposta. 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: Retorna o questionário mais recente de um domínio/serviço. tags: – Queries x-senior-visibility: PRIVATE 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: Identificador do questionário. default: description: Error response schema: #/definitions/genericError get: description: Retorna o questionário mais recente de um domínio/serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Domínio. in: query required: true type: string – name: serviceName description: Serviço. 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: Identificador do questionário. default: description: Error response schema: #/definitions/genericError /question_service/queries/listUsersThatAnsweredQuestionnaire: post: description: Lista os usuários que responderam a determinado questionário. tags: – Queries x-senior-visibility: PRIVATE 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: Lista os usuários que responderam a determinado questionário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: questionnaireId description: Identificador do questionário. 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: 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: 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: default: description: Error response schema: #/definitions/genericError /question_service/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 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 default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaire: post: description: Responde as perguntas. tags: – Actions x-senior-visibility: PRIVATE 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: Identificador da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaireAnonymous: post: description: Reponde as perguntas de forma anônima. tags: – Actions x-senior-visibility: PRIVATE 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: Identificador da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/actions/answerQuestionnaireByOther: post: description: Reponde as perguntas por outra pessoa. tags: – Actions x-senior-visibility: PRIVATE 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: Identificador da resposta criada. default: description: Error response schema: #/definitions/genericError /question_service/entities/answeredAlternative: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/answeredAlternative default: description: Error response schema: #/definitions/genericError /question_service/entities/answeredAlternative/{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/answeredAlternative responses: 200: description: Ok schema: #/definitions/answeredAlternative 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/answeredAlternative responses: 200: description: Ok schema: #/definitions/answeredAlternative 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/answeredAlternative 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/answeredAlternative/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/answeredAlternative responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/questionnaire: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/questionnaire default: description: Error response schema: #/definitions/genericError /question_service/entities/questionnaire/{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/questionnaire responses: 200: description: Ok schema: #/definitions/questionnaire 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/questionnaire responses: 200: description: Ok schema: #/definitions/questionnaire 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/questionnaire 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/questionnaire/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/questionnaire responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/question: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/question default: description: Error response schema: #/definitions/genericError /question_service/entities/question/{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/question responses: 200: description: Ok schema: #/definitions/question 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/question responses: 200: description: Ok schema: #/definitions/question 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/question 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/question/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/question responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/alternative: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/alternative default: description: Error response schema: #/definitions/genericError /question_service/entities/alternative/{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/alternative responses: 200: description: Ok schema: #/definitions/alternative 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/alternative responses: 200: description: Ok schema: #/definitions/alternative 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/alternative 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/alternative/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/alternative responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/answer: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/answer default: description: Error response schema: #/definitions/genericError /question_service/entities/answer/{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/answer responses: 200: description: Ok schema: #/definitions/answer 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/answer responses: 200: description: Ok schema: #/definitions/answer 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/answer 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/answer/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/answer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/textAnswer: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/textAnswer default: description: Error response schema: #/definitions/genericError /question_service/entities/textAnswer/{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/textAnswer responses: 200: description: Ok schema: #/definitions/textAnswer 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/textAnswer responses: 200: description: Ok schema: #/definitions/textAnswer 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/textAnswer 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/textAnswer/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/textAnswer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /question_service/entities/levelAnswer: post: tags: – CRUD x-senior-visibility: PRIVATE 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 patch: tags: – CRUD x-senior-visibility: PRIVATE 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 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/levelAnswer default: description: Error response schema: #/definitions/genericError /question_service/entities/levelAnswer/{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/levelAnswer responses: 200: description: Ok schema: #/definitions/levelAnswer 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/levelAnswer responses: 200: description: Ok schema: #/definitions/levelAnswer 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/levelAnswer 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 default: description: Error response schema: #/definitions/genericError /question_service/entities/levelAnswer/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/levelAnswer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN 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 único 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: Sequência em que essa questão deve ser apresentada. alternatives: type: array items: type: object allOf: – #/definitions/answeredAlternative description: Alternativas dessa questão. text: type: string description: Texto respondido quando do tipo texto livre. 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 único da alternativa. description: type: string description: Descrição da alternativa. sequence: type: integer format: int64 description: Sequência em que essa alternativa deve ser apresentada. checked: type: boolean description: Indica que a alternativa foi selecionada. Quando do tipo única escolha ou escolha livre. 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: Questões 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 única 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 da 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 do tipo nível. minimum: 0 maximum: 10 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/heathcheckDTO description: Status questionnaire: description: Questionário. type: object required: – title – domainName – serviceName properties: id: type: string description: Identificador único da entidade. type: string description: Título 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: Sequência em que essa questão deve ser apresentada. 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 a qual essa alternativa está associada. sequence: type: integer format: int64 description: Sequência em que essa alternativa deve ser apresentada. 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 texto livre da questão. type: object required: – questionId properties: questionId: type: string description: Identificador único da 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 nível. type: object required: – questionId properties: questionId: type: string description: Identificador único da 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: 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. 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