Mais pesquisados:Customização, Tutorial, Documentação

moods_batch

13 views 0 05/08/2024 Atualizado em 16/10/2024 integrador

2.0info: 1.2.2 moods_batch x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: moods_batch contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /moods_batch/queries/helloWorld: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – who properties: who: type: string description: responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: who description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckEnum description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckEnum description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportClimateSurvey: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportPulse: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportPulseRespondent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportPulseRespondentSender: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportAnswerTicket: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/exportEmployeeUsername: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/batchPulseGenerate: post: description: Operação de geração das notificações para os respondentes após a criação do Pulso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – respondents properties: respondents: type: array items: type: object allOf: – #/definitions/recRespondent minimum: 1 description: Lista dos respondentes e em quais meios ele deve ser notificado responses: 200: description: Ok schema: type: object required: – pulsePlatform – pulseEmail – pulseSms – pulseWaapi properties: pulsePlatform: type: array items: type: object allOf: – #/definitions/PulseSenderDto minimum: 1 description: Lista de notificação enviada para plataforma pulseEmail: type: array items: type: object allOf: – #/definitions/PulseSenderEmailDto minimum: 1 description: Lista de notificação enviada para email pulseSms: type: array items: type: object allOf: – #/definitions/PulseSenderSmsDto minimum: 1 description: Lista de notificação enviada para sms pulseWaapi: type: array items: type: object allOf: – #/definitions/PulseSenderWaapiDto minimum: 1 description: Lista de notificação enviada para waapi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importClimateSurvey: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importPulse: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importPulseRespondent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importPulseRespondentSender: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importAnswerTicket: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/actions/importEmployeeUsername: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/events/importClimateSurveyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportClimateSurveyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importPulseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportPulseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importPulseRespondentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportPulseRespondentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importPulseRespondentSenderEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportPulseRespondentSenderEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importAnswerTicketEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportAnswerTicketEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/importEmployeeUsernameEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/events/exportEmployeeUsernameEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /moods_batch/entities/climateSurvey: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/climateSurvey responses: 200: description: The created resource schema: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/climateSurvey responses: 200: description: The created resource schema: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/climateSurvey/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: Ok schema: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: Ok schema: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/climateSurvey 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/climateSurvey/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/climateSurvey responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondent responses: 200: description: The created resource schema: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondent responses: 200: description: The created resource schema: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: Ok schema: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: Ok schema: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseRespondent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pulseRespondent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondentSender: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondentSender responses: 200: description: The created resource schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondentSender responses: 200: description: The created resource schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondentSender/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondentSender responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondentSender responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondent/{parentId}/pulseRespondentSender: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondentSender responses: 200: description: The created resource schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/pulseRespondentSender responses: 200: description: The created resource schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondent/{parentId}/pulseRespondentSender/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondentSender responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondentSender responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseRespondentSender 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/pulseRespondentSender/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pulseRespondentSender responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/employeeUsername: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeUsername responses: 200: description: The created resource schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeUsername responses: 200: description: The created resource schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/employeeUsername/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/employee/{parentId}/usernames: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeeUsername responses: 200: description: The created resources schema: type: array items: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeeUsername responses: 200: description: The created resources schema: type: array items: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/employee/{parentId}/usernames/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeUsername 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /moods_batch/entities/employeeUsername/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeUsername responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckEnum: description: Status do healthcheck type: string enum: – UP – DOWN periodicity: description: Periodicidade type: string enum: – FORTNIGHTLY – WEEKLY – DAILY – MONTHLY – QUARTERLY monthlyPeriodicity: description: Periodicidade mensal type: string enum: – DAILY – WEEKLY monthOfYear: description: Meses do Ano type: string enum: – JANUARY – FEBRUARY – MARCH – APRIL – MAY – JUNE – JULY – AUGUST – SEPTEMBER – OCTOBER – NOVEMBER – DECEMBER dayOfWeek: description: Dias da semana type: string enum: – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY – SUNDAY weekOfMonth: description: Semanas do mês. type: string enum: – FIRST – SECOND – THIRD – FOURTH – LAST notificationType: description: Tipo da notificação a ser enviada type: string enum: – PLATFORM – EMAIL – SMS – WAAPI employeeType: description: Tipo do colaborador type: string enum: – EMPLOYEE – THIRDPARTY pulseSendType: description: Tipo de envio do pulso type: string enum: – EMAIL – SMS – BOTH pulseRespondentStatusType: description: Status de erro ao enviar pulso type: string enum: – INVALID_MAIL – MAIL_EMPLOYEE_NOT_SAVE – PHONE_EMPLOYEE_NOT_SAVE – EMPLOYEE_NOT_IN_HIERARCHY – LEADER_NOT_EVALUATED – THIRDPARTIES_NOT_ALLOWED 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 – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthCheckEnum description: Status recRespondent: description: Registro de respondente type: object required: – respondentId properties: respondentId: type: string description: Identificador do respondente PulseSenderBaseDto: description: DTO de envio de pulso discriminator: _discriminator type: object required: – respondentId – notification – _discriminator properties: respondentId: type: string description: Identificador do respondente notification: type: string allOf: – #/definitions/notificationType description: Tipo de notificação _discriminator: type: string description: PulseSenderDto: description: DTO de envio de pulso para plataforma allOf: – #/definitions/PulseSenderBaseDto – type: object required: – usernames – shortLink – message properties: usernames: type: array items: type: string minimum: 1 description: Nome do usuário shortLink: type: string description: Link curto para questionário message: type: string description: Mensagem a ser enviada PulseSenderWaapiDto: description: DTO de envio de pulso para plataforma allOf: – #/definitions/PulseSenderBaseDto – type: object required: – usernames – shortLink – message – title – content properties: usernames: type: array items: type: string minimum: 1 description: Nome do usuário shortLink: type: string description: Link curto para questionário message: type: string description: Mensagem a ser enviada type: string description: Titulo da notificação content: type: string description: Conteudo da notificação PulseSenderEmailDto: description: DTO de envio de pulso para email allOf: – #/definitions/PulseSenderBaseDto – type: object required: – email – body – title – longlink properties: email: type: string description: Email do usuário para onde será enviada a notificação body: type: string description: Corpo do email type: string description: Título do email longlink: type: string description: Link longo para acesso ao questionário PulseSenderSmsDto: description: DTO de envio de pulso para sms allOf: – #/definitions/PulseSenderBaseDto – type: object required: – phone – shortLink – message properties: phone: type: string description: shortLink: type: string description: message: type: string description: climateSurvey: description: Pesquisa de clima. type: object properties: id: type: string description: Identificador único da entidade. enabled: type: boolean description: Indica se a pesquisa está ativa. periodicity: type: string allOf: – #/definitions/periodicity description: Periodicidade da pesquisa. monthOfYear: type: string allOf: – #/definitions/monthOfYear description: Inicia no Mês. dayOfWeek: type: string allOf: – #/definitions/dayOfWeek description: Dia da semana que a pesquisa deve ser realizada. emailMessage: type: string description: Mensagem em texto padrão referente a configuração do email da pesquisa. emailMessageHtml: type: string description: Mensagem em HTML que deve ser enviada no email da pesquisa. emailMessageHtmlCustom: type: string description: Mensagem em HTML personalizada que deve ser enviada no email da pesquisa. startImageId: type: string description: Identificador único da imagem que deve ser apresentada no início da pesquisa. startTitle: type: string description: Título da mensagem que deve ser apresentada no início da pesquisa. startMessage: type: string description: Mensagem que deve ser apresentada no início da pesquisa. endImageId: type: string description: Identificador único da imagem que deve ser apresentada no fim da pesquisa. endTitle: type: string description: Link para acessar a imagem que deve ser apresentada no fim da pesquisa. endMessage: type: string description: Mensagem que deve ser apresentada no fim da pesquisa. questionsCount: type: integer format: int64 description: Quantidade máxima de perguntas que o pulso deve ter. minimum: 1 maximum: 99 default: 5 showEngagement: type: boolean description: Indica se deve apresentar o engajamento aos gestores showComments: type: boolean description: Indica se deve apresentar os comentários dos pulsos aos gestores hcmAutoSync: type: boolean description: Indica se será feito a sincronização automática coupledHcm: type: boolean description: Indica se o Moods está acoplado com o HCM dayOfMonth: type: integer format: int64 description: Dia do mês que a pesquisa deve ser realizada (apenas periodicity MONTHLY) weekOfMonth: type: string allOf: – #/definitions/weekOfMonth description: Semana do mês que a pesquisa deve ser realizada (apenas periodicity MONTHLY) monthlyPeriodicity: type: string allOf: – #/definitions/monthlyPeriodicity description: Caso periodicity = MONTHLY indica qual o tipo de periodicidade mensal (dia do mês ou dia da semana no mês) smsMessage: type: string description: Mensagem de texto padrão referente a configuração do SMS da pesquisa leaders: type: array items: type: object allOf: – #/definitions/employee description: Líderes allowThirdParties: type: boolean description: Indica se o pulso deve ser enviado para colaboradores terceiros disableNPSQuestion: type: boolean description: Indica se a pesquisa pode considerar o a aplicação da questão do NPS numberReminderCalculation: type: integer format: int64 description: Numero para cálculo do envio do lembrete pulsePlatformNotification: type: boolean description: Indica se o pulso deve ser enviado pela notificação da plataforma sendSms: type: boolean description: Indica se o pulso deve ser enviado via SMS sendEmail: type: boolean description: Indica se o pulso deve ser enviado via e-mail sendPlatform: type: boolean description: Indica se o pulso deve ser enviado via plataforma platformMessage: type: string description: Mensagem de texto padrão referente a configuração da notificação da pesquisa sendWaapi: type: boolean description: Indica se o pulso deve ser enviado via waapi waapiMessage: type: string description: Mensagem de texto padrão referente a configuração da notificação da pesquisa via waapi waapiTitleMessage: type: string description: Titulo padrão referente a configuração da notificação da pesquisa via waapi pulse: description: Pulso type: object properties: id: type: string description: Identificador único do pulso. createdAt: type: string format: date-time description: Momento em que o pulso foi criado endAt: type: string format: date-time description: Momento em que o pulso será finalizado survey: type: object allOf: – #/definitions/climateSurvey description: Pesquisa a qual o pulso está relacionado npsQuestion: type: boolean description: Informa se o pulso tem a questão NPS pulseSequence: type: integer format: int64 description: Número sequencial de identificação do pulso processed: type: boolean description: Indica se o pulso ja foi processado default: false leaders: type: array items: type: object allOf: – #/definitions/employee description: Líderes que serão avaliados no pulso. answers: type: array items: type: object allOf: – #/definitions/answerTicket description: Respostas dos respondentes do pulso. respondents: type: array items: type: object allOf: – #/definitions/pulseRespondent description: Respondentes deste pulso pulsePlatformNotification: type: boolean description: Status do envio do pulso pela plataforma pulseRespondent: description: Respondente do pulso type: object properties: id: type: string description: Identificador do respondente pulse: type: object allOf: – #/definitions/pulse description: Pulso que será respondido respondent: type: object allOf: – #/definitions/employee description: Respondente do pulso email: type: string description: Email do respondente phone: type: string description: Telefone do respondente leader: type: object allOf: – #/definitions/employee description: Líder do respondente sent: type: boolean description: Flag identificando se o pulso será/foi enviado para o respondente statusErrorSent: type: string allOf: – #/definitions/pulseRespondentStatusType description: Erro ao enviar pulso errorDescription: type: string description: Descrição do erro sendSms: type: boolean description: Flag identificando se o pulso deve ser enviado via SMS default: false sendEmail: type: boolean description: Flag identificando se o pulso deve ser enviado via e-mail default: false sendPlatform: type: boolean description: Flag identificando se o pulso deve ser enviado via plataforma default: false queued: type: boolean description: Flag identificando se o respondente já foi enfileirado para envio default: false pulseRespondentSender: type: object allOf: – #/definitions/pulseRespondentSender description: Detalhes do envio do pulso pulseRespondentSender: description: Dados de Envio do Pulso ao Respondente type: object properties: id: type: string description: Identificador único da entidade smsStatus: type: boolean description: Flag identificando se o pulso foi enviado via SMS default: false smsError: type: string description: Erro gerado pelo envio via SMS emailStatus: type: boolean description: Flag identificando se o pulso foi enviado via e-mail default: false emailError: type: string description: Erro gerado pelo envio via e-mail platformStatus: type: boolean description: Flag identificando se o pulso foi enviado via plataforma default: false platformError: type: string description: Erro gerado pelo envio via plataforma waapiStatus: type: boolean description: Flag identificando se o pulso foi enviado via waapi default: false waapiError: type: string description: Erro gerado pelo envio via waapi answerTicket: description: Resposta de um respondente do pulso. type: object properties: id: type: string description: Identificador único da entidade. pulse: type: object allOf: – #/definitions/pulse description: Pulso a qual a resposta está associada. leader: type: object allOf: – #/definitions/employee description: Lider do respondente do pulso. employee: type: object allOf: – #/definitions/employee description: Respondente longUrl: type: string description: URL de acesso ao questionário shortUrl: type: string description: URL de acesso ao questionário encurtada isEmailSent: type: boolean description: Flag identificando se houve erro ao enviar email default: false isSmsSent: type: boolean description: Flag identificando se houve erro ao enviar SMS default: false answered: type: boolean description: Indica se a resposta foi respondida employee: description: Colaborador type: object properties: id: type: string description: Identificador único da entidade registernumber: type: integer format: int64 description: Código do colaborador minimum: 1 maximum: 999999999 cpf: type: string description: CPF do Colaborador name: type: string description: Nome do colaborador email: type: string description: Email do colaborador countryCodePhone: type: integer format: int64 description: Código do país do celular do colaborador localCodePhone: type: integer format: int64 description: Código de área do celular do colaborador numberPhone: type: integer format: int64 description: Numero do celular do colaborador birthday: type: string format: date description: Data de nascimento do colaborador admissionDate: type: string format: date description: Data de admissão do colaborador dismissalDate: type: string format: date description: Data de demissão do colaborador pulseSendType: type: string allOf: – #/definitions/pulseSendType description: Tipo de envio do pulso ao respondente surveyAnalyst: type: boolean description: Indicação de que o colaborador é analista da pesquisa idg5: type: string description: Código do colaborador na G5 – NumEmp;TipCol;NumCad blocked: type: boolean description: Indica se o colaborador está bloqueado excluded: type: boolean description: Indica se o colaborador está excluído usernames: type: array items: type: object allOf: – #/definitions/employeeUsername description: Nome dos usuários. (Login G7) pulses: type: array items: type: object allOf: – #/definitions/pulse description: Pulsos relacionados ao líder surveys: type: array items: type: object allOf: – #/definitions/climateSurvey description: Pesquisas relacionados ao líder employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador employeeUsername: description: Relação de colaborador e usuário type: object required: – username properties: id: type: string description: Identificador Único employee: type: object allOf: – #/definitions/employee description: Colaborador username: type: string description: Usuário notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação