Hcm Development

2.0info: 0.0.3-SNAPSHOT Serviço do gestão de desenvolvimento. /bridge/rest/hcm – application/json – application/jsonpaths: /development/queries/whoIsRunning: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna o ip e hostname que recebeu a requisição. tags: – Queries responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname 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 ip e hostname que recebeu a requisição. tags: – Queries responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname default: description: Error response schema: #/definitions/genericError /development/queries/notificationsTest: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Dispara de forma forçada todas as notificações. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId – courseClassParticipantId properties: courseClassId: type: string description: Id de uma turma. courseClassParticipantId: type: string description: Id de um participante. responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse 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. Dispara de forma forçada todas as notificações. tags: – Queries parameters: – name: courseClassId in: query required: true type: string – name: courseClassParticipantId in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/queries/listEffectivenessPendencies: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista as as avaliações de eficácia pendentes. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – employeeId – referenceDate properties: employeeId: type: string maxLength: 32 description: Identificador do lider. referenceDate: type: string format: date description: Data de referencia. responses: 200: description: Ok schema: type: object allOf: – #/definitions/effectivenessCourseClasses 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 as as avaliações de eficácia pendentes. tags: – Queries parameters: – name: employeeId in: query required: true type: string maxLength: 32 – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/effectivenessCourseClasses default: description: Error response schema: #/definitions/genericError /development/queries/getQuestionnaireByEvaluationKey: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna o questionário de uma turma, baseado no hash de resposta. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – evaluationKey properties: evaluationKey: type: string description: Hash da resposta. responses: 200: description: Ok schema: type: object required: – courseName – instructor – minDateWhen – maxDateWhen – evaluationPeriodInitial – evaluationPeriodFinal – questionnaireId – answered properties: courseName: type: string maxLength: 255 description: Nome do curso. instructor: type: string description: Nome do instrutor minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. evaluationPeriodInitial: type: string format: date description: Data inicial de avaliação. evaluationPeriodFinal: type: string format: date description: Data final de avaliação. questionnaireId: type: string description: Id do questionário. answered: type: boolean description: Indica que já existe um resposta para o hash informado 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 de uma turma, baseado no hash de resposta. tags: – Queries parameters: – name: evaluationKey in: query required: true type: string responses: 200: description: Ok schema: type: object required: – courseName – instructor – minDateWhen – maxDateWhen – evaluationPeriodInitial – evaluationPeriodFinal – questionnaireId – answered properties: courseName: type: string maxLength: 255 description: Nome do curso. instructor: type: string description: Nome do instrutor minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. evaluationPeriodInitial: type: string format: date description: Data inicial de avaliação. evaluationPeriodFinal: type: string format: date description: Data final de avaliação. questionnaireId: type: string description: Id do questionário. answered: type: boolean description: Indica que já existe um resposta para o hash informado default: description: Error response schema: #/definitions/genericError /development/queries/searchWorkShifts: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Autocomplete de turnos de trabalho. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Texto a ser buscado responses: 200: description: Ok schema: type: object required: – workShifts properties: workShifts: type: array items: type: object allOf: – #/definitions/workShift minimum: 1 description: Lista de turnos encontrados. 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. Autocomplete de turnos de trabalho. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – workShifts properties: workShifts: type: array items: type: object allOf: – #/definitions/workShift minimum: 1 description: Lista de turnos encontrados. default: description: Error response schema: #/definitions/genericError /development/queries/searchDepartments: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Autocomplete de departamento. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Texto a ser buscado responses: 200: description: Ok schema: type: object required: – departments properties: departments: type: array items: type: object allOf: – #/definitions/department minimum: 1 description: Lista de departamentos. 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. Autocomplete de departamento. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – departments properties: departments: type: array items: type: object allOf: – #/definitions/department minimum: 1 description: Lista de departamentos. default: description: Error response schema: #/definitions/genericError /development/queries/searchCompanies: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Autocomplete de empresas. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Texto a ser buscado responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Lista de empresas encontradas. 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. Autocomplete de empresas. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Lista de empresas encontradas. default: description: Error response schema: #/definitions/genericError /development/queries/searchCostCenters: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Autocomplete de centro de custo. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – companyId properties: q: type: string description: Texto a ser buscado companyId: type: string description: Identificador da empresa. responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/costCenter minimum: 1 description: Lista de centros de custo encontrados. 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. Autocomplete de centro de custo. tags: – Queries parameters: – name: q in: query type: string – name: companyId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/costCenter minimum: 1 description: Lista de centros de custo encontrados. default: description: Error response schema: #/definitions/genericError /development/queries/searchPersons: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca para as pessoas baseado no nome completo das mesmas. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – referenceDate properties: q: type: string description: Expressão a ser encontrada. referenceDate: type: string format: date description: Data de referência da pesquisa. responses: 200: description: Ok schema: type: object properties: people: type: array items: type: object allOf: – #/definitions/person description: Lista de pessoas que possuem o nome completo de acordo com a à expressão informada. 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. Serviço de busca para as pessoas baseado no nome completo das mesmas. tags: – Queries parameters: – name: q in: query type: string – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object properties: people: type: array items: type: object allOf: – #/definitions/person description: Lista de pessoas que possuem o nome completo de acordo com a à expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/searchJobPositions: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca para os cargos baseado no nome dos mesmos. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: q: type: string description: Expressão a ser encontrada. employeeId: type: string description: ID do colaborador que terá sua estrutura de cargos como referência para a pesquisa. responses: 200: description: Ok schema: type: object properties: jobPositions: type: array items: type: object allOf: – #/definitions/jobPosition description: Lista de cargos que possuem o nome de acordo com a à expressão informada. 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. Serviço de busca para os cargos baseado no nome dos mesmos. tags: – Queries parameters: – name: q in: query type: string – name: employeeId in: query required: true type: string responses: 200: description: Ok schema: type: object properties: jobPositions: type: array items: type: object allOf: – #/definitions/jobPosition description: Lista de cargos que possuem o nome de acordo com a à expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/searchEmployees: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca para os colaboradores baseado no nome completo dos mesmos. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – referenceDate properties: q: type: string description: Expressão a ser encontrada. referenceDate: type: string format: date description: Data de referência da pesquisa. leaderId: type: string description: Id do colaborador lider. responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSummary description: Lista de colaboradores que possuem o nome completo de acordo com a à expressão informada. 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. Serviço de busca para os colaboradores baseado no nome completo dos mesmos. tags: – Queries parameters: – name: q in: query type: string – name: referenceDate in: query required: true type: string format: date – name: leaderId in: query type: string responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSummary description: Lista de colaboradores que possuem o nome completo de acordo com a à expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/listEmployeeContractsOfCurrentUser: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna uma lista contendo os contratos de colaborador referentes ao usuário da sessão. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – referenceDate properties: referenceDate: type: string format: date description: Data de referência da pesquisa. responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSummary description: Lista de contratos de colaborador referentes ao usuário da sessão. 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 uma lista contendo os contratos de colaborador referentes ao usuário da sessão. tags: – Queries parameters: – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSummary description: Lista de contratos de colaborador referentes ao usuário da sessão. default: description: Error response schema: #/definitions/genericError /development/queries/newUuid: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Gera um novo ID no padrão HCMUUID. tags: – Queries responses: 200: description: Ok schema: type: object required: – uuid properties: uuid: type: string maxLength: 32 description: Id gerado. 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. Gera um novo ID no padrão HCMUUID. tags: – Queries responses: 200: description: Ok schema: type: object required: – uuid properties: uuid: type: string maxLength: 32 description: Id gerado. default: description: Error response schema: #/definitions/genericError /development/queries/searchCourseGroups: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca pelo nome para os grupos de cursos. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Expressão a ser encontrada. responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/courseGroup minimum: 1 description: Lista de grupos encontrados de acordo com a expressão informada. 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. Serviço de busca pelo nome para os grupos de cursos. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/courseGroup minimum: 1 description: Lista de grupos encontrados de acordo com a expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/searchCourses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca pelo nome cursos. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Expressão a ser encontrada. responses: 200: description: Ok schema: type: object required: – courses properties: courses: type: array items: type: object allOf: – #/definitions/course minimum: 1 description: Lista de cursos encontrados de acordo com a expressão informada. 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. Serviço de busca pelo nome cursos. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – courses properties: courses: type: array items: type: object allOf: – #/definitions/course minimum: 1 description: Lista de cursos encontrados de acordo com a expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/listCoursePaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem paginada de cursos. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseListPaged 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. Listagem paginada de cursos. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseListPaged default: description: Error response schema: #/definitions/genericError /development/queries/listCourseClassSchedules: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem de agendamento de uma turma. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId properties: courseClassId: type: string description: Identificador da turma. responses: 200: description: Ok schema: type: object required: – courseClassSchedules properties: courseClassSchedules: type: array items: type: object allOf: – #/definitions/courseClassSchedule minimum: 1 description: Lista de agendamentos da turma. 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. Listagem de agendamento de uma turma. tags: – Queries parameters: – name: courseClassId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – courseClassSchedules properties: courseClassSchedules: type: array items: type: object allOf: – #/definitions/courseClassSchedule minimum: 1 description: Lista de agendamentos da turma. default: description: Error response schema: #/definitions/genericError /development/queries/listCourseClassesPaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem de turmas. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/courseClassListPagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseClassListPaged 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. Listagem de turmas. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 – name: situation in: query type: string – name: courseType in: query type: string – name: startPeriod in: query type: string format: date – name: endPeriod in: query type: string format: date – name: places in: query type: array items: type: string – name: instructors in: query type: array items: type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseClassListPaged default: description: Error response schema: #/definitions/genericError /development/queries/listCourseClassParticipants: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem de participantes de uma turma. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId properties: courseClassId: type: string description: Identificador da turma. responses: 200: description: Ok schema: type: object required: – courseClassParticipants properties: courseClassParticipants: type: array items: type: object allOf: – #/definitions/courseClassParticipantSummary minimum: 1 description: Lista de paticipantes da turma. 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. Listagem de participantes de uma turma. tags: – Queries parameters: – name: courseClassId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – courseClassParticipants properties: courseClassParticipants: type: array items: type: object allOf: – #/definitions/courseClassParticipantSummary minimum: 1 description: Lista de paticipantes da turma. default: description: Error response schema: #/definitions/genericError /development/queries/listCourseAttachments: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem dos anexos de um curso/treinamento. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseId properties: courseId: type: string description: ID do curso/treinamento que deve ter seus anexos retornados. responses: 200: description: Ok schema: type: object required: – courseAttachments properties: courseAttachments: type: array items: type: object allOf: – #/definitions/courseAttachmentSummary minimum: 1 description: Anexos do curso/treinamento em questão. 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. Listagem dos anexos de um curso/treinamento. tags: – Queries parameters: – name: courseId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – courseAttachments properties: courseAttachments: type: array items: type: object allOf: – #/definitions/courseAttachmentSummary minimum: 1 description: Anexos do curso/treinamento em questão. default: description: Error response schema: #/definitions/genericError /development/queries/listCourseClassAttachments: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem dos anexos de um curso/treinamento. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId properties: courseClassId: type: string description: ID da turma que deve ter seus anexos retornados. responses: 200: description: Ok schema: type: object required: – courseAttachments properties: courseAttachments: type: array items: type: object allOf: – #/definitions/courseClassAttachmentSummary minimum: 1 description: Anexos da turma em questão. 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. Listagem dos anexos de um curso/treinamento. tags: – Queries parameters: – name: courseClassId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – courseAttachments properties: courseAttachments: type: array items: type: object allOf: – #/definitions/courseClassAttachmentSummary minimum: 1 description: Anexos da turma em questão. default: description: Error response schema: #/definitions/genericError /development/queries/publishedCourseClassList: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista de turmas publicadas. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – referenceDate properties: referenceDate: type: string format: date description: Data de referência. responses: 200: description: Ok schema: type: object required: – courseClasses properties: courseClasses: type: array items: type: object allOf: – #/definitions/publishedCourseClass minimum: 1 description: Lista de turmas. 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 de turmas publicadas. tags: – Queries parameters: – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – courseClasses properties: courseClasses: type: array items: type: object allOf: – #/definitions/publishedCourseClass minimum: 1 description: Lista de turmas. default: description: Error response schema: #/definitions/genericError /development/queries/searchCourseClassHeader: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca informações da turma tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId properties: courseClassId: type: string maxLength: 32 description: Identificador da Turma responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseClassHeader 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. Busca informações da turma tags: – Queries parameters: – name: courseClassId in: query required: true type: string maxLength: 32 responses: 200: description: Ok schema: type: object allOf: – #/definitions/courseClassHeader default: description: Error response schema: #/definitions/genericError /development/queries/listPublishedCourseClassPaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista detalhada de turmas publicadas. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/publishedCourseClassPagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/publishedCourseClassPaged 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 detalhada de turmas publicadas. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/publishedCourseClassPaged default: description: Error response schema: #/definitions/genericError /development/queries/quantityOfStartedClasses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Retorna quantidade de turmas iniciadas. tags: – Queries responses: 200: description: Ok schema: type: object required: – quantity properties: quantity: type: integer format: int64 description: Quantidade de turmas iniciadas. 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 quantidade de turmas iniciadas. tags: – Queries responses: 200: description: Ok schema: type: object required: – quantity properties: quantity: type: integer format: int64 description: Quantidade de turmas iniciadas. default: description: Error response schema: #/definitions/genericError /development/queries/quantityOfScheduledClasses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca quantidade de turmas agendadas. tags: – Queries responses: 200: description: Ok schema: type: object required: – quantity properties: quantity: type: integer format: int64 description: Quantidade de turmas agendadas 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. Busca quantidade de turmas agendadas. tags: – Queries responses: 200: description: Ok schema: type: object required: – quantity properties: quantity: type: integer format: int64 description: Quantidade de turmas agendadas default: description: Error response schema: #/definitions/genericError /development/queries/listSubordinatesParticipantsPaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista de liderados participantes. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/courseClassParticipantsLeaderPagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/participantsPaged 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 de liderados participantes. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 – name: courseClassId in: query required: true type: string maxLength: 32 – name: employeeId in: query required: true type: string maxLength: 32 – name: referenceDate in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/participantsPaged default: description: Error response schema: #/definitions/genericError /development/queries/listParticipantsPaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Lista detalhada de turmas publicadas. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/courseClassParticipantsPagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/participantsPaged 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 detalhada de turmas publicadas. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 – name: courseClassId in: query required: true type: string maxLength: 32 – name: status in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/participantsPaged default: description: Error response schema: #/definitions/genericError /development/queries/courseClassLeaderSummary: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Resumo da turma. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – courseClassId properties: courseClassId: type: string maxLength: 32 description: Identificador da turma. responses: 200: description: Ok schema: type: object required: – id – courseName – period – instructor – duration – remaining – minDateWhen – maxDateWhen properties: id: type: string maxLength: 32 description: Identificador da entidade. instituionName: type: string maxLength: 255 description: Nome da instituição em que o curso foi lecionado. courseName: type: string maxLength: 255 description: Nome do curso. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. instructor: type: string maxLength: 255 description: Instrutor. duration: type: number format: double description: Carga horaria do curso. remaining: type: integer format: int64 description: Quantidade de vagas restantes. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. 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. Resumo da turma. tags: – Queries parameters: – name: courseClassId in: query required: true type: string maxLength: 32 responses: 200: description: Ok schema: type: object required: – id – courseName – period – instructor – duration – remaining – minDateWhen – maxDateWhen properties: id: type: string maxLength: 32 description: Identificador da entidade. instituionName: type: string maxLength: 255 description: Nome da instituição em que o curso foi lecionado. courseName: type: string maxLength: 255 description: Nome do curso. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. instructor: type: string maxLength: 255 description: Instrutor. duration: type: number format: double description: Carga horaria do curso. remaining: type: integer format: int64 description: Quantidade de vagas restantes. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. default: description: Error response schema: #/definitions/genericError /development/queries/searchPlacesFromCourseClasses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca de locais de acordo com os já cadastrados nas turmas dos cursos/treinamentos. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Expressão a ser encontrada. responses: 200: description: Ok schema: type: object required: – places properties: places: type: array items: type: string minimum: 1 description: Lista contendo os locais encontrados de acordo com a expressão informada. 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. Serviço de busca de locais de acordo com os já cadastrados nas turmas dos cursos/treinamentos. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – places properties: places: type: array items: type: string minimum: 1 description: Lista contendo os locais encontrados de acordo com a expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/searchInstructorsFromCourseClasses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Serviço de busca de instrutores/palestrantes de acordo com os já cadastrados nas turmas dos cursos/treinamentos. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Expressão a ser encontrada. responses: 200: description: Ok schema: type: object required: – instructors properties: instructors: type: array items: type: string minimum: 1 description: Lista contendo os instrutores/palestrantes encontrados de acordo com a expressão informada. 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. Serviço de busca de instrutores/palestrantes de acordo com os já cadastrados nas turmas dos cursos/treinamentos. tags: – Queries parameters: – name: q in: query type: string responses: 200: description: Ok schema: type: object required: – instructors properties: instructors: type: array items: type: string minimum: 1 description: Lista contendo os instrutores/palestrantes encontrados de acordo com a expressão informada. default: description: Error response schema: #/definitions/genericError /development/queries/searchYearsWithConcludedClasses: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca informação de turmas concluídas. tags: – Queries responses: 200: description: Ok schema: type: object allOf: – #/definitions/yearsWithConcludedClassesOutput 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. Busca informação de turmas concluídas. tags: – Queries responses: 200: description: Ok schema: type: object allOf: – #/definitions/yearsWithConcludedClassesOutput default: description: Error response schema: #/definitions/genericError /development/queries/numberOfConcludedClassesPerYear: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os meses do ano com turmas concluídas tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – year properties: year: type: string description: Ano de referência responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithConcludedClasses 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. Busca os meses do ano com turmas concluídas tags: – Queries parameters: – name: year in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithConcludedClasses default: description: Error response schema: #/definitions/genericError /development/queries/numberOfParticipantsConcludedClassesPerYear: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os meses do ano com participantes de turmas concluídas tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – year properties: year: type: string description: Ano de referência responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithParticipantsConcludedClasses 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. Busca os meses do ano com participantes de turmas concluídas tags: – Queries parameters: – name: year in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithParticipantsConcludedClasses default: description: Error response schema: #/definitions/genericError /development/queries/avarageHoursOfParticipantsConcludedClassesPerYear: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os meses do ano com as médias usadas pelos participantes nas turmas concluídas tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – year properties: year: type: string description: Ano de referência responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithAvarageHoursParticipantsConcludedClasses 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. Busca os meses do ano com as médias usadas pelos participantes nas turmas concluídas tags: – Queries parameters: – name: year in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/monthsWithAvarageHoursParticipantsConcludedClasses default: description: Error response schema: #/definitions/genericError /development/queries/verifyCourseClassRelation: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Verifica se o curso tem relação com alguma turma tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – course properties: course: type: string maxLength: 32 description: Id do curso responses: 200: description: Ok schema: type: object required: – hasRelation properties: hasRelation: type: boolean description: Indica se o curso tem relação com alguma classe 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. Verifica se o curso tem relação com alguma turma tags: – Queries parameters: – name: course in: query required: true type: string maxLength: 32 responses: 200: description: Ok schema: type: object required: – hasRelation properties: hasRelation: type: boolean description: Indica se o curso tem relação com alguma classe default: description: Error response schema: #/definitions/genericError /development/queries/listRequirementGroupPaged: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Listagem paginada de grupo de requisitos. tags: – Queries parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pagedInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/requirementGroupListPaged 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. Listagem paginada de grupo de requisitos. tags: – Queries parameters: – name: q in: query type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/requirementGroupListPaged default: description: Error response schema: #/definitions/genericError /development/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 /development/queries/exportCourseGroup: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourse: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseClass: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseClassSchedule: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseClassParticipant: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseAttachment: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseClassAttachment: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportCourseClassEvaluationKey: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportRequirementgroup: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportRequirementgrouprevision: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportJobpositionrequirement: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/queries/exportWorkstationgrouprequirement: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /development/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 /development/actions/requestParticipation: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicita a participação de um colaborador em uma turma. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassId – employeeId properties: courseClassId: type: string maxLength: 32 description: Identificador da turma. employeeId: type: string maxLength: 32 description: Identificador do colaborador que deseja participar. responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/setEffectivenessAnswer: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Vincula uma reposta de avaliação de eficácia à um participante. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassParticipantId – answerId properties: courseClassParticipantId: type: string description: Id do participante. answerId: type: string description: Id da resposta responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/cancelScheduledCourseClass: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Cancela um turma que está com o status agendado tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassId – justification properties: courseClassId: type: string maxLength: 255 description: Id da turma justification: type: string maxLength: 255 description: Justificativa para o cancelamento da turma responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/confirmAnsweredEvaluationKey: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Muda o status da hash informada para respondido. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – evaluationKey properties: evaluationKey: type: string description: Hash da resposta. responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/acceptSubordinateParticipation: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicita a participação de um colaborador liderado em uma turma. tags: – Actions parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/acceptInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/acceptParticipation: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicita a participação de um colaborador em uma turma. tags: – Actions parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/acceptInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/requestUploadFile: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicitação para realizar o upload de um arquivo. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. ttl: type: integer format: int64 description: Tempo em minutos que a área temporária criada para o upload do arquivo deve ficar disponível. responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. default: description: Error response schema: #/definitions/genericError /development/actions/commitUploadedFile: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Realiza o commit de um arquivo que foi carregado anteriormente. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(90X90px) responses: 200: description: Ok schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. default: description: Error response schema: #/definitions/genericError /development/actions/requestFileAccess: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicitação para acessar um arquivo. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado. thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(90X90px) responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download. default: description: Error response schema: #/definitions/genericError /development/actions/deleteFile: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicitação para apagar um arquivo. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser apagado seu Thumbnail(90X90px) responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/requestUpdateFile: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Solicitação para realizar o update em um arquivo armazenado. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – fileId – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. locationURI: type: string description: URI onde o arquivo temporário se encontra responses: 200: description: Ok schema: type: object required: – version – uploadURI properties: type: string description: Versão do arquivo. uploadURI: type: string description: URI onde o upload deve ser realizado. default: description: Error response schema: #/definitions/genericError /development/actions/startCourseClass: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Inicia uma turma tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassId – employeeId – dateRef properties: courseClassId: type: string maxLength: 32 description: Identificador do curso. employeeId: type: string maxLength: 32 description: Identificador do empregado que iniciou a turma. dateRef: type: string format: date-time description: Data de inicio da turma. responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/finishCourseClass: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Finaliza uma turma tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassId – employeeId – dateRef properties: courseClassId: type: string maxLength: 32 description: Identificador do curso. employeeId: type: string maxLength: 32 description: Identificador do empregado que iniciou a turma. dateRef: type: string format: date-time description: Data de conclusao da turma. responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/evaluateCourseClassParticipant: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Cadastra a nota final de um participante de uma turma. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassParticipantId properties: courseClassParticipantId: type: string description: ID do participante da turma que deve receber a nota. grade: type: number format: double description: Nota que o participante informado deve receber. minimum: 0.00 maximum: 100.00 responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/attendanceCourseClassParticipant: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Cadastra a frequência de um participante de uma turma. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – courseClassParticipantId properties: courseClassParticipantId: type: string description: ID do participante da turma que deve receber a nota. attendance: type: number format: double description: Nota que o participante informado deve receber. minimum: 0.00 maximum: 100.00 responses: 200: description: Ok schema: type: object allOf: – #/definitions/simpleResponse default: description: Error response schema: #/definitions/genericError /development/actions/odata: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. tags: – Actions responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /development/actions/importCourseGroup: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourse: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseClass: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseClassSchedule: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseClassParticipant: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseAttachment: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseClassAttachment: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importCourseClassEvaluationKey: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importRequirementgroup: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importRequirementgrouprevision: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importJobpositionrequirement: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/actions/importWorkstationgrouprequirement: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /development/entities/courseGroup: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseGroup responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseGroup responses: 200: description: The created resource schema: #/definitions/courseGroup default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseGroup default: description: Error response schema: #/definitions/genericError /development/entities/courseGroup/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseGroup responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseGroup responses: 200: description: Ok schema: #/definitions/courseGroup default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseGroup default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/course: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/course responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/course responses: 200: description: The created resource schema: #/definitions/course default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/course default: description: Error response schema: #/definitions/genericError /development/entities/course/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/course responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/course responses: 200: description: Ok schema: #/definitions/course default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/course default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseClass: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClass responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClass responses: 200: description: The created resource schema: #/definitions/courseClass default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseClass default: description: Error response schema: #/definitions/genericError /development/entities/courseClass/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClass responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClass responses: 200: description: Ok schema: #/definitions/courseClass default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseClass default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseClassSchedule: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassSchedule responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassSchedule responses: 200: description: The created resource schema: #/definitions/courseClassSchedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseClassSchedule default: description: Error response schema: #/definitions/genericError /development/entities/courseClassSchedule/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassSchedule responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassSchedule responses: 200: description: Ok schema: #/definitions/courseClassSchedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseClassSchedule default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseClassParticipant: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassParticipant responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassParticipant responses: 200: description: The created resource schema: #/definitions/courseClassParticipant default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseClassParticipant default: description: Error response schema: #/definitions/genericError /development/entities/courseClassParticipant/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassParticipant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassParticipant responses: 200: description: Ok schema: #/definitions/courseClassParticipant default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseClassParticipant default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseAttachment: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseAttachment responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseAttachment responses: 200: description: The created resource schema: #/definitions/courseAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseAttachment default: description: Error response schema: #/definitions/genericError /development/entities/courseAttachment/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseAttachment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseAttachment responses: 200: description: Ok schema: #/definitions/courseAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseAttachment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseClassAttachment: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassAttachment responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassAttachment responses: 200: description: The created resource schema: #/definitions/courseClassAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseClassAttachment default: description: Error response schema: #/definitions/genericError /development/entities/courseClassAttachment/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassAttachment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassAttachment responses: 200: description: Ok schema: #/definitions/courseClassAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseClassAttachment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/courseClassEvaluationKey: post: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassEvaluationKey responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/courseClassEvaluationKey responses: 200: description: The created resource schema: #/definitions/courseClassEvaluationKey default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/courseClassEvaluationKey default: description: Error response schema: #/definitions/genericError /development/entities/courseClassEvaluationKey/{id}: put: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassEvaluationKey responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/courseClassEvaluationKey responses: 200: description: Ok schema: #/definitions/courseClassEvaluationKey default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/courseClassEvaluationKey default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /development/entities/requirementgroup: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/requirementgroup 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/requirementgroup responses: 200: description: The created resource schema: #/definitions/requirementgroup 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/requirementgroup default: description: Error response schema: #/definitions/genericError /development/entities/requirementgroup/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/requirementgroup 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/requirementgroup responses: 200: description: Ok schema: #/definitions/requirementgroup 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/requirementgroup 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 /development/entities/requirementgrouprevision: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/requirementgrouprevision 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/requirementgrouprevision responses: 200: description: The created resource schema: #/definitions/requirementgrouprevision 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/requirementgrouprevision default: description: Error response schema: #/definitions/genericError /development/entities/requirementgrouprevision/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/requirementgrouprevision 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/requirementgrouprevision responses: 200: description: Ok schema: #/definitions/requirementgrouprevision 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/requirementgrouprevision 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 /development/entities/jobpositionrequirement: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobpositionrequirement 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/jobpositionrequirement responses: 200: description: The created resource schema: #/definitions/jobpositionrequirement 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/jobpositionrequirement default: description: Error response schema: #/definitions/genericError /development/entities/jobpositionrequirement/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobpositionrequirement 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/jobpositionrequirement responses: 200: description: Ok schema: #/definitions/jobpositionrequirement 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/jobpositionrequirement 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 /development/entities/workstationgrouprequirement: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstationgrouprequirement 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/workstationgrouprequirement responses: 200: description: The created resource schema: #/definitions/workstationgrouprequirement 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/workstationgrouprequirement default: description: Error response schema: #/definitions/genericError /development/entities/workstationgrouprequirement/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstationgrouprequirement 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/workstationgrouprequirement responses: 200: description: Ok schema: #/definitions/workstationgrouprequirement 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/workstationgrouprequirement 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: notificationTypeDto: description: Tipos de notificação. type: string enum: – EMAIL – PLATFORM – PLATFORM_EMAIL shiftDto: description: Turnos de trabalho. type: string enum: – FIRST_TURN – SECOND_TURN – THIRD_TURN – FOURTH_TURN – MIST – GENERAL disabilityDto: description: Deficiência type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL courseTypeDto: description: Tipos de cursos. type: string enum: – COURSE – ON_THE_JOB – WORKSHOP – LECTURE – CONFERENCE – SEMINARY periodTypeDto: description: Periodo de estudo. type: string enum: – MORNING – AFTERNOON – NIGHT – FULL_TIME situationDto: description: Situações. type: string enum: – NOT_STARTED – IN_PROGRESS – FINISHED – CANCELLED participantStatusDto: description: Status do participante na turma. type: string enum: – PENDING – CONFIRMED – REJECTED 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 pagedInput: description: Entrada base de retorno paginado, deve ser extendido para campos adicionais. discriminator: _discriminator type: object required: – _discriminator properties: q: type: string description: Expressão a ser encontrada para busca por palavra chave. page: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. size: type: integer format: int64 description: Quantidade de itens que devem ser retornados por página. Padrão 20. _discriminator: type: string description: courseClassParticipantsPagedInput: description: Entrada para o retorno paginado de participantes. allOf: – #/definitions/pagedInput – type: object required: – courseClassId – status properties: courseClassId: type: string maxLength: 32 description: Identificador da turma. status: type: string allOf: – #/definitions/participantStatusDto description: Situação buscada. courseClassParticipantsLeaderPagedInput: description: Entrada para o retorno paginado de liderados participantes. allOf: – #/definitions/pagedInput – type: object required: – courseClassId – employeeId – referenceDate properties: courseClassId: type: string maxLength: 32 description: Identificador da turma. employeeId: type: string maxLength: 32 description: Identificador do lider. referenceDate: type: string format: date description: Data de referencia. publishedCourseClassPagedInput: description: Entrada para o retorno paginado de turmas para os colaboradores. allOf: – #/definitions/pagedInput – type: object required: – referenceDate properties: referenceDate: type: string format: date description: Data de referencia. courseClassListPagedInput: description: Entrada para o retorno paginado de turmas. allOf: – #/definitions/pagedInput – type: object properties: situation: type: string allOf: – #/definitions/situationDto description: Situação a ser considerada na busca. courseType: type: string allOf: – #/definitions/courseTypeDto description: Tipo de curso a ser considerado na busca. startPeriod: type: string format: date description: Inicio do período que deve ser considerado na busca. endPeriod: type: string format: date description: Término do período que deve ser considerado na busca. places: type: array items: type: string description: Lista contendo as tags referentes aos locais que devem ser considerados na busca. instructors: type: array items: type: string description: Lista contendo as tags referentes aos instrutores que devem ser considerados na busca. paged: description: Retorno paginado, deve ser extendido. discriminator: _discriminator type: object required: – found – page – isMoreItemsAvailable – _discriminator properties: found: type: integer format: int64 description: Indica quantos registros foram encontrados. page: type: integer format: int64 description: Indica o índice da próxima página. isMoreItemsAvailable: type: boolean description: Indica se existem mais registros a serem retornados. _discriminator: type: string description: participantsPaged: description: Listagem paginada de participantes subordinados. allOf: – #/definitions/paged – type: object required: – courseClassParticipants properties: courseClassParticipants: type: array items: type: object allOf: – #/definitions/courseClassParticipantSummary minimum: 1 description: Participantes. courseListPaged: description: Retorno paginado da lista de cursos. allOf: – #/definitions/paged – type: object required: – courses properties: courses: type: array items: type: object allOf: – #/definitions/courseList minimum: 1 description: Lista de cursos da pagina atual. effectivenessCourseClasses: description: Listagem de turmas com avaliação de eficácia pendentes. type: object required: – courseClasses properties: courseClasses: type: array items: type: object allOf: – #/definitions/effectivenessCourseClass minimum: 1 description: Lista da turmas. effectivenessCourseClass: description: Listagem de turmas com avliação de eficácia pendentes. type: object required: – courseClassId – courseName – instructor – local – institutionName – minDateWhen – maxDateWhen – effectivenessQuestionnaire – effectivenessPeriodFinal – expired properties: courseClassId: type: string description: Identificador da turma. courseName: type: string description: Nome do curso. instructor: type: string description: Nome do instrutor. local: type: string description: Local de realização. institutionName: type: string description: Instituição. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. effectivenessQuestionnaire: type: string description: Id do questionário de avaliação de eficácia. effectivenessPeriodFinal: type: string format: date-time description: Período da avaliação de eficácia final. expired: type: boolean description: Indica que está vencido. courseClassListPaged: description: Retorno paginado da lista de turmas. allOf: – #/definitions/paged – type: object required: – courseClasses – quantityOfNotStartedCoursesClasses – quantityOfInProgressCoursesClasses – quantityOfCancelledCoursesClasses – quantityOfFinishedCoursesClasses – quantityOfCourseClasses properties: courseClasses: type: array items: type: object allOf: – #/definitions/courseClassList minimum: 1 description: Lista de turmas da pagina atual. quantityOfNotStartedCoursesClasses: type: integer format: int64 description: Quantidade de turmas que se encontram na situação NOT_STARTED (Não iniciada). quantityOfInProgressCoursesClasses: type: integer format: int64 description: Quantidade de turmas que se encontram na situação IN_PROGRESS (Em andamento). quantityOfCancelledCoursesClasses: type: integer format: int64 description: Quantidade de turmas que se encontram na situação FINISHED (Concluído). quantityOfFinishedCoursesClasses: type: integer format: int64 description: Quantidade de turmas que se encontram na situação CANCELLED (Cancelada). quantityOfCourseClasses: type: integer format: int64 description: Quantidade de turmas, indiferentemente de status. publishedCourseClassPaged: description: Retorno paginado da lista de turmas publicadas. allOf: – #/definitions/paged – type: object required: – courseClasses properties: courseClasses: type: array items: type: object allOf: – #/definitions/courseClassDetailList minimum: 1 description: Lista de turmas da pagina atual. acceptInput: description: Entrada da aprovação de candidatos. type: object required: – courseClassParticipantId – accept properties: courseClassParticipantId: type: string maxLength: 32 description: Identificador do participant na turma. accept: type: boolean description: Indica se a participação será aceita. courseClassParticipantSummary: description: Resumo do participante da turma. type: object required: – id – participant – status properties: id: type: string maxLength: 32 description: Identificador da entidade. participant: type: object allOf: – #/definitions/employeeSummary description: O colaborador participante. status: type: string allOf: – #/definitions/participantStatusDto description: Situação da participação grade: type: number format: double description: Nota final do participante perante a turma. attendance: type: number format: double description: Frequência do participante na turma. courseClassList: description: Retorna para a lista de turmas type: object required: – id – courseName – period – instructor – situation – minDateWhen – maxDateWhen properties: id: type: string maxLength: 32 description: Identificador da entidade. courseName: type: string maxLength: 255 description: Nome do curso. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. instructor: type: string maxLength: 255 description: Instrutor. situation: type: string allOf: – #/definitions/situationDto description: Situação da turma. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. courseClassDetailList: description: Retorna para a lista de turmas type: object required: – id – courseName – period – instructor – remaining – minDateWhen – maxDateWhen – alreadySubscribed properties: id: type: string maxLength: 32 description: Identificador da entidade. courseName: type: string maxLength: 255 description: Nome do curso. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. instructor: type: string maxLength: 255 description: Instrutor. remaining: type: integer format: int64 description: Quantidade de vagas restantes. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. alreadySubscribed: type: boolean description: Indica que o usuário atual já se inscreveu na vaga. publishedCourseClass: description: Lista de turmas publicadas. type: object required: – courseName – minDateWhen – maxDateWhen properties: courseName: type: string maxLength: 255 description: Nome do curso. minDateWhen: type: string format: date description: Data miníma de realização. maxDateWhen: type: string format: date description: Data maxíma de realização. courseList: description: Retorna para a lista de cursos. type: object required: – id – name – type – groupName properties: id: type: string maxLength: 32 description: Identificador da entidade. name: type: string maxLength: 255 description: Nome do curso. type: type: string allOf: – #/definitions/courseTypeDto description: Tipo do curso. groupName: type: string maxLength: 255 description: Nome do grupo simpleResponse: description: Retorno simples quando não há retorno no action type: object required: – ok properties: ok: type: boolean description: Indica que se foi executado com sucesso. person: description: Pessoa. type: object required: – fullName – username properties: id: type: string description: Identificador único da entidade. fullName: type: string description: Nome completo da pessoa. username: type: string description: Nome de usuário da pessoa. photoLink: type: string description: Link foto. photoThumbnailLink: type: string description: Link foto miniatura. employee: description: Colaborador. type: object properties: id: type: string description: Identificador único da entidade. person: type: object allOf: – #/definitions/person description: Pessoa a qual o contrato de colaborador referência dimissalDate: type: string format: date description: Data de demissão do colaborador (Se for o caso). employeeSummary: description: Informações compostas do colaborador. type: object properties: employee: type: object allOf: – #/definitions/employee description: Informações básicas do colaborador. workstationGroupName: type: string description: Nome do grupo de posto de trabalho do colaborador. jobPositionName: type: string description: Nome do cargo do colaborador. companyName: type: string description: Nome da empresa em que o colaborador trabalha. jobPosition: description: Cargo. type: object properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome do cargo. company: description: Centro de custo. type: object required: – companyName – headQuarterId – headQuarter properties: id: type: string description: Identificador do centro de custo. companyName: type: string description: Nome da Empresa. headQuarterId: type: string description: Identificador da Empresa Matriz. headQuarter: type: object allOf: – #/definitions/company description: Empresa Matriz. costCenter: description: Centro de custo. type: object required: – companyId – name – code properties: id: type: string description: Identificador do centro de custo. companyId: type: string description: Identificador da Empresa. company: type: object allOf: – #/definitions/company description: Empresa. name: type: string description: Nome do centro de custo. code: type: string description: Código do centro de custo. workShift: description: Turnos de trabalho. type: object required: – description – shift properties: id: type: string description: Identificador do centro de custo. description: type: string description: Descrição do turno. shift: type: string allOf: – #/definitions/shiftDto description: Turno department: description: Departamento. type: object required: – name – description properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome. description: type: string description: Descrição. attachment: description: Dados referentes a um anexo hospedado no BlobService. discriminator: _discriminator type: object required: – fileId – _discriminator properties: fileId: type: string description: Id do arquivo que representa o anexo no BlobService fileURI: type: string description: Link (URI) para consumo do do arquivo que representa o anexo em questão. size: type: string description: Tamanho do arquivo em questão (Em bytes). _discriminator: type: string description: courseAttachmentSummary: description: Resumo de um anexo de um curso/treinamento. allOf: – #/definitions/attachment – type: object required: – courseAttachmentId properties: courseAttachmentId: type: string description: ID da entidade que armazena o anexo e faz a ligação do mesmo com o curso/treinamento. courseClassAttachmentSummary: description: Resumo de um anexo de um curso/treinamento. allOf: – #/definitions/attachment – type: object required: – courseClassAttachmentId properties: courseClassAttachmentId: type: string description: ID da entidade que armazena o anexo e faz a ligação do mesmo com o curso/treinamento. courseClassHeader: description: Informações cabeçalho turma type: object required: – id – canFinishCourseClass – courseName – beginDate – endDate – period – instructor – maxParticipants – remaining – duration – situation – confirmedTotal – pendingTotal – evaluationPeriodInitial – evaluationPeriodFinal – inscriptionPeriodInitial – inscriptionPeriodFinal – type properties: id: type: string maxLength: 32 description: Identificador da entidade. canFinishCourseClass: type: boolean description: Indica se a turma pode ser concluída ou não. institutionName: type: string maxLength: 255 description: Instituição de ensino que vai ministrar a turma. courseName: type: string maxLength: 255 description: Nome do curso. beginDate: type: string format: date description: Data inicio de realização. endDate: type: string format: date description: Data fim de realização. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. instructor: type: string maxLength: 255 description: Instrutor. maxParticipants: type: integer format: int64 description: Quantidade máxima de participantes. remaining: type: integer format: int64 description: Quantidade de vagas restantes. duration: type: number format: double description: Carga horária. situation: type: string allOf: – #/definitions/situationDto description: Situação da turma. confirmedTotal: type: integer format: int64 description: Total de participantes confirmados. pendingTotal: type: integer format: int64 description: Total de participantes pendentes. place: type: string maxLength: 255 description: Local em que será lecionado para a turma. cancellationJustification: type: string maxLength: 255 description: Justificativa do cancelamento da turma evaluationPeriodInitial: type: string format: date description: Período da avaliação inicial evaluationPeriodFinal: type: string format: date description: Período da avaliação final inscriptionPeriodInitial: type: string format: date description: Período de inscrição inicial inscriptionPeriodFinal: type: string format: date description: Período de inscrição final type: type: string allOf: – #/definitions/courseTypeDto description: Tipo do curso (curso, on the job, workshop, palestra, conferência, seminário). yearsWithConcludedClassesOutput: description: Retorna lista de anos que possuem turmas concluídas type: object required: – years properties: years: type: array items: type: string minimum: 1 description: Anos que possuem turmas concluídas monthsWithConcludedClasses: description: Armazena lista de meses com a quantidade de turmas concluídas. type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/month minimum: 1 description: Representa uma lista de meses de um determinado ano. monthsWithParticipantsConcludedClasses: description: Armazena lista de meses com a quantidade de participantes de turmas concluídas. type: object required: – months properties: months: type: array items: type: object allOf: – #/definitions/month minimum: 1 description: Representa uma lista de meses de um determinado ano. month: description: Representa o mês em um gráfico. type: object required: – name – value – average properties: name: type: string description: Descrição do mês. value: type: integer format: int64 description: Representa a soma de determinado valor no mes. average: type: integer format: int64 description: Média de value. monthsWithAvarageHoursParticipantsConcludedClasses: description: Armazena lista de meses com as médias de horas usadas pelos participantes nas turmas concluídas. type: object required: – avarage – months properties: avarage: type: number format: double description: Representa a média de todos os meses do ano months: type: array items: type: object allOf: – #/definitions/monthAvarageHours minimum: 1 description: Representa uma lista de meses com as médias, de um determinado ano. monthAvarageHours: description: Representa o mês do gráfico com uma média. type: object required: – name – value properties: name: type: string description: Descrição do mês. value: type: number format: double description: Representa a média de horas usadas em treinamento de um determinado mês. requirementGroupListPaged: description: Retorno paginado da lista de grupo de requisitos. allOf: – #/definitions/paged – type: object required: – groupOfRequirements properties: groupOfRequirements: type: array items: type: object allOf: – #/definitions/requirementGroupList minimum: 1 description: Lista de grupo de requisitos da pagina atual. requirementGroupList: description: Retorna para a lista de grupo de requisitos. type: object required: – id – name properties: id: type: string maxLength: 32 description: Identificador da entidade. name: type: string maxLength: 200 description: Nome do grupo de requisito. courseGroup: description: Grupo de cursos. type: object required: – name properties: id: type: string maxLength: 32 description: Identificador da entidade. name: type: string maxLength: 255 description: Nome do grupo. createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data de alterarção. course: description: Curso/Treinamento. type: object required: – name properties: id: type: string maxLength: 32 description: Identificador da entidade. name: type: string maxLength: 255 description: Nome do curso. content: type: string description: Objetivo do curso. type: type: string allOf: – #/definitions/courseTypeDto description: Tipo do curso. courseGroup: type: object allOf: – #/definitions/courseGroup description: grupo do curso duration: type: number format: double description: Carga horaria do curso. maximum: 9999 expiration: type: integer format: int64 description: Validade do curso em meses. maximum: 999 createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data de alterarção. courseClass: description: Turmas. type: object required: – course properties: id: type: string maxLength: 32 description: Identificador da entidade. course: type: object allOf: – #/definitions/course description: Curso. institutionName: type: string maxLength: 255 description: Instituição de ensino que vai ministrar a turma. details: type: string description: Detalhes da turma. place: type: string maxLength: 255 description: Local. participants: type: integer format: int64 description: Número de participantes. period: type: string allOf: – #/definitions/periodTypeDto description: Periodo. type: type: string allOf: – #/definitions/courseTypeDto description: Tipo. instructor: type: string maxLength: 255 description: Instrutor. situation: type: string allOf: – #/definitions/situationDto description: Situação da turma. createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data de alterarção. startedAt: type: string format: date-time description: Data de início finishedAt: type: string format: date-time description: Data de conclusão startedBy: type: string maxLength: 32 description: Empregado que iniciou finishedBy: type: string maxLength: 32 description: Empregado que concluiu inscriptionPeriodInitial: type: string format: date description: Período de inscrição inicial inscriptionPeriodFinal: type: string format: date description: Período de inscrição final evaluationPeriodInitial: type: string format: date description: Período da avaliação inicial evaluationPeriodFinal: type: string format: date description: Período da avaliação final quiz: type: string maxLength: 32 description: O questionário referênciado justification: type: string maxLength: 255 description: Justificativa para o cancelamento da turma (quando agendada). effectivenessQuestionnaire: type: string maxLength: 32 description: Id do questionário de avaliação de eficácia. courseClassSchedule: description: Agendamentos da turma. type: object required: – courseClass – dateWhen – startTime – endTime properties: id: type: string maxLength: 32 description: Identificador da entidade. courseClass: type: object allOf: – #/definitions/courseClass description: Curso. dateWhen: type: string format: date description: Data do agendamento. startTime: type: string description: Hora de início. endTime: type: string description: Hora de termíno. createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data de alterarção. courseClassParticipant: description: Participantes da turma type: object required: – courseClass – employee properties: id: type: string maxLength: 32 description: Identificador da entidade. courseClass: type: object allOf: – #/definitions/courseClass description: Turma. employee: type: string description: O colaborador participante. status: type: string allOf: – #/definitions/participantStatusDto description: Status da participação. grade: type: number format: double description: Nota final do participante perante a turma. minimum: 0.00 maximum: 100.00 createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data de alterarção. attendance: type: number format: double description: Frequência do participante na turma. minimum: 0.00 maximum: 100.00 effectivenessAnswer: type: string maxLength: 32 description: Identificador da resposta da avaliação de eficácia courseAttachment: description: Anexo de um curso/treinamento. type: object required: – course – fileId properties: id: type: string maxLength: 32 description: Identificador da entidade. course: type: object allOf: – #/definitions/course description: Curso/Treinamento a qual o anexo pertence. fileId: type: string description: ID do arquivo que representa o anexo do curso/treinamento no BlobService. courseClassAttachment: description: Anexo de uma turma. type: object required: – courseClass – fileId properties: id: type: string maxLength: 32 description: Identificador da entidade. courseClass: type: object allOf: – #/definitions/courseClass description: Turma a qual o anexo pertence. fileId: type: string description: ID do arquivo que representa o anexo do curso/treinamento no BlobService. courseClassEvaluationKey: description: Chave utilizada para realizar a avaliação do curso type: object required: – courseClass – evaluationKey – answered – createdAt – updatedAt properties: id: type: string maxLength: 32 description: Identificador da entidade. courseClass: type: object allOf: – #/definitions/courseClass description: Curso concluído. evaluationKey: type: string description: Valor único para cada avaliação. answered: type: boolean description: Flag que indica se o questionário já foi respondido baseado no código enviado. createdAt: type: string format: date-time description: Data em que a chave foi gerada. updatedAt: type: string format: date-time description: Data/hora de alteração. requirementgroup: description: Entidade com os dados de grupos de requisitos. type: object required: – description – name – applyinginevaluation – sucessor properties: id: type: string maxLength: 32 description: Identificador da entidade. description: type: string maxLength: 4000 description: Descrição sobre o grupo de requisito. name: type: string maxLength: 200 description: Nome do grupo de requisito. applyinginevaluation: type: boolean description: Indicativo se este grupo deve ser considerado na criação das avaliações de competência. sucessor: type: boolean description: Indicativo se este grupo deve complementar ou substituir os demais grupos. requirementgrouprevision: description: Entidade com os dados da revisão do grupo de requisitos. type: object required: – enddate – requirementgroup – revision – startdate properties: id: type: string maxLength: 32 description: Identificador da entidade. enddate: type: string format: date description: Data de fim. requirementgroup: type: object allOf: – #/definitions/requirementgroup description: Grupo de requisitos. revision: type: string maxLength: 4000 description: Decrição da revisão do grupo de requisitos. startdate: type: string format: date description: Data de início. jobpositionrequirement: description: Relaciona as entidades JobPosition e RequirementGroup type: object required: – requirementgroup – startdate – enddate properties: id: type: string maxLength: 32 description: Identificador da entidade. requirementgroup: type: object allOf: – #/definitions/requirementgroup description: Grupo de requisitos. jobposition: type: string maxLength: 32 description: Cargo startdate: type: string format: date description: Data de início. enddate: type: string format: date description: Data de fim. workstationgrouprequirement: description: Relaciona as entidades WorkstationGroup e RequirementGroup type: object required: – requirementgroup – startdate – enddate properties: id: type: string maxLength: 32 description: Identificador da entidade. requirementgroup: type: object allOf: – #/definitions/requirementgroup description: Grupo de requisitos. workstationgroup: type: string maxLength: 32 description: Grupo de estação de trabalho startdate: type: string format: date description: Data de início. enddate: type: string format: date description: Data de fim. 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. 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