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

managementpanelemployeejourney

233 views 0 18/10/2021 Atualizado em 05/09/2023 integrador

2.0info: 1.7.1 managementpanelemployeejourney x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: managementpanelemployeejourney 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: /managementpanelemployeejourney/queries/healthcheck: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/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 /managementpanelemployeejourney/queries/exportEducationDegree: 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 /managementpanelemployeejourney/queries/exportAddress: 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 /managementpanelemployeejourney/queries/exportCity: 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 /managementpanelemployeejourney/queries/exportState: 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 /managementpanelemployeejourney/queries/exportNationality: 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 /managementpanelemployeejourney/queries/exportPerson: 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 /managementpanelemployeejourney/queries/exportNis: 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 /managementpanelemployeejourney/queries/exportEmail: 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 /managementpanelemployeejourney/queries/exportPhoneContact: 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 /managementpanelemployeejourney/queries/exportDisability: 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 /managementpanelemployeejourney/queries/exportPersonDisability: 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 /managementpanelemployeejourney/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 /managementpanelemployeejourney/queries/exportDepartment: 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 /managementpanelemployeejourney/queries/exportWorkShift: 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 /managementpanelemployeejourney/queries/exportJobPosition: 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 /managementpanelemployeejourney/queries/exportCompany: 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 /managementpanelemployeejourney/queries/exportCostCenter: 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 /managementpanelemployeejourney/queries/exportWorkstation: 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 /managementpanelemployeejourney/queries/exportWorkstationGroup: 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 /managementpanelemployeejourney/queries/exportEmployeeEmail: 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 /managementpanelemployeejourney/queries/exportHierarchyItem: 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 /managementpanelemployeejourney/queries/exportHistoricStability: 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 /managementpanelemployeejourney/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 /managementpanelemployeejourney/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/actions/importEducationDegree: 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 /managementpanelemployeejourney/actions/importAddress: 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 /managementpanelemployeejourney/actions/importCity: 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 /managementpanelemployeejourney/actions/importState: 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 /managementpanelemployeejourney/actions/importNationality: 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 /managementpanelemployeejourney/actions/importPerson: 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 /managementpanelemployeejourney/actions/importNis: 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 /managementpanelemployeejourney/actions/importEmail: 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 /managementpanelemployeejourney/actions/importPhoneContact: 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 /managementpanelemployeejourney/actions/importDisability: 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 /managementpanelemployeejourney/actions/importPersonDisability: 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 /managementpanelemployeejourney/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 /managementpanelemployeejourney/actions/importDepartment: 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 /managementpanelemployeejourney/actions/importWorkShift: 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 /managementpanelemployeejourney/actions/importJobPosition: 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 /managementpanelemployeejourney/actions/importCompany: 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 /managementpanelemployeejourney/actions/importCostCenter: 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 /managementpanelemployeejourney/actions/importWorkstation: 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 /managementpanelemployeejourney/actions/importWorkstationGroup: 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 /managementpanelemployeejourney/actions/importEmployeeEmail: 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 /managementpanelemployeejourney/actions/importHierarchyItem: 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 /managementpanelemployeejourney/actions/importHistoricStability: 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 /managementpanelemployeejourney/events/importEducationDegreeEvent: 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 /managementpanelemployeejourney/events/exportEducationDegreeEvent: 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 /managementpanelemployeejourney/events/importAddressEvent: 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 /managementpanelemployeejourney/events/exportAddressEvent: 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 /managementpanelemployeejourney/events/importCityEvent: 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 /managementpanelemployeejourney/events/exportCityEvent: 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 /managementpanelemployeejourney/events/importStateEvent: 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 /managementpanelemployeejourney/events/exportStateEvent: 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 /managementpanelemployeejourney/events/importNationalityEvent: 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 /managementpanelemployeejourney/events/exportNationalityEvent: 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 /managementpanelemployeejourney/events/importPersonEvent: 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 /managementpanelemployeejourney/events/exportPersonEvent: 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 /managementpanelemployeejourney/events/importNisEvent: 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 /managementpanelemployeejourney/events/exportNisEvent: 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 /managementpanelemployeejourney/events/importEmailEvent: 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 /managementpanelemployeejourney/events/exportEmailEvent: 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 /managementpanelemployeejourney/events/importPhoneContactEvent: 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 /managementpanelemployeejourney/events/exportPhoneContactEvent: 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 /managementpanelemployeejourney/events/importDisabilityEvent: 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 /managementpanelemployeejourney/events/exportDisabilityEvent: 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 /managementpanelemployeejourney/events/importPersonDisabilityEvent: 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 /managementpanelemployeejourney/events/exportPersonDisabilityEvent: 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 /managementpanelemployeejourney/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 /managementpanelemployeejourney/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 /managementpanelemployeejourney/events/importDepartmentEvent: 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 /managementpanelemployeejourney/events/exportDepartmentEvent: 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 /managementpanelemployeejourney/events/importWorkShiftEvent: 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 /managementpanelemployeejourney/events/exportWorkShiftEvent: 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 /managementpanelemployeejourney/events/importJobPositionEvent: 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 /managementpanelemployeejourney/events/exportJobPositionEvent: 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 /managementpanelemployeejourney/events/importCompanyEvent: 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 /managementpanelemployeejourney/events/exportCompanyEvent: 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 /managementpanelemployeejourney/events/importCostCenterEvent: 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 /managementpanelemployeejourney/events/exportCostCenterEvent: 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 /managementpanelemployeejourney/events/importWorkstationEvent: 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 /managementpanelemployeejourney/events/exportWorkstationEvent: 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 /managementpanelemployeejourney/events/importWorkstationGroupEvent: 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 /managementpanelemployeejourney/events/exportWorkstationGroupEvent: 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 /managementpanelemployeejourney/events/importEmployeeEmailEvent: 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 /managementpanelemployeejourney/events/exportEmployeeEmailEvent: 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 /managementpanelemployeejourney/events/importHierarchyItemEvent: 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 /managementpanelemployeejourney/events/exportHierarchyItemEvent: 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 /managementpanelemployeejourney/events/importHistoricStabilityEvent: 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 /managementpanelemployeejourney/events/exportHistoricStabilityEvent: 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 /managementpanelemployeejourney/entities/educationDegree: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/educationDegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/address: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/city: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/state: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/nationality: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/person: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/nis: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/nis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/email: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/phoneContact: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/phoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/disability: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/disability 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/personDisability: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personDisability 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/employee: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/department: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/workShift: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/workShift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/jobPosition: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/company: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/costCenter: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/workstation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/workstationGroup: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/employeeEmail: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employeeEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/hierarchyItem: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementpanelemployeejourney/entities/historicStability: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/historicStability 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Resultado do Health Check type: string enum: – UP – DOWN genderType: description: Gênero da pessoa. type: string enum: – MALE – FEMALE maritalStatusType: description: Estado civil type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLE_UNION – OTHER racialType: description: Raça type: string enum: – NOT_INFORMED – WHITE – BLACK – BROWN – YELLOW – INDIAN disabilityType: description: Tipo de deficiência type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL – OTHER contractType: description: Tipo de Contrato type: string enum: – EMPLOYEE – MANAGER – FARM_WORKER – RETIRED – TRAINEE – APRENDIZ – FIXED_DUE_DATE – RETIRED_MANAGER – PUBLIC_AGENT – TEACHER – COOPERATIVE_WORKER – DOMESTIC_WORKER – TEACHER_FIXED_DUE_DATE – THIRD_PARTY phoneContactType: description: Tipo Contato Telefone type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER employmentRelationshipType: description: Tipo relacionamento do colaborador type: string enum: – EMPREGADO_GERAL – EMPREGADO_TRABALHADOR_RURAL_POR_PEQUENO_PRAZO_DA_LEI_11_718_2008 – EMPREGADO_APRENDIZ – EMPREGADO_DOMESTICO – EMPREGADO_CONTRATO_A_TERMO_FIRMADO_NOS_TERMOS_DA_LEI_9601_98 – TRABALHADOR_TEMPORARIO_CONTRATO_NOS_TERMOS_DA_LEI_6019_74 – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_SEM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_COM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_INTERMITENTE – TRABALHADOR_AVULSO_PORTUARIO – TRABALHADOR_AVULSO_NAO_PORTUARIO – SERVIDOR_PUBLICO_TITULAR_DE_CARGO_EFETIVO_MAGISTRADO_MINISTRO_DE_TRIBUNAL_DE_CONTAS_CONSELHEIRO_DE_TRIBUNAL_CONTAS_E_MEMBRO_DO_MINISTERIO_PUBLICO – SERVIDOR_PUBLICO_OCUPANTE_DE_CARGO_EXCLUSIVO_EM_COMISSAO – EXERCENTE_DE_MANDATO_ELETIVO – SERVIDOR_PUBLICO_EXERCENTE_DE_MANDATO_ELETIVO_INCLUSIVE_COM_EXERCICIO_DE_CARGO_EM_COMISSAO – SERVIDOR_PUBLICO_INDICADO_PARA_CONSELHO_OU_ORGAO_REPRESENTATIVO_NA_CONDICAO_DE_REPRESENTANTE_DO_GOVERNO_ORGAO_OU_ENTIDADE_DA_ADMINISTRACAO_PUBLICA – SERVIDOR_PUBLICO_CONTRATADO_POR_TEMPO_DETERMINADO_SUJEITO_A_REGIME_ADMINISTRATIVO_ESPECIAL_DEFINIDO_EM_LEI_PROPRIA – MILITAR – CONSCRITO – AGENTE_PUBLICO_OUTROS – SERVIDOR_PUBLICO_EVENTUAL – MINISTROS_JUIZES_PROCURADORES_PROMOTORES_OU_OFICIAIS_DE_JUSTICA_A_DISPOSICAO_DA_JUSTICA_ELEITORAL – AUXILIAR_LOCAL – SERVIDOR_PUBLICO_EXERCENTE_DE_ATIVIDADE_DE_INSTRUTORIA_CAPACITACAO_TREINAMENTO_CURSO_OU_CONCURSO_OU_CONVOCADO_PARA_PARECERES_TECNICOS_OU_DEPOIMENTOS – DIRIGENTE_SINDICAL_INFORMACAO_PRESTADA_PELO_SINDICATO – TRABALHADOR_CEDIDO_EXERCICIO_EM_OUTRO_ORGAO_JUIZ_AUXILIAR_INFORMACAO_PRESTADA_PELO_CESSIONARIO_DESTINO – CONTRIBUINTE_INDIVIDUAL_AUTONOMO_EM_GERAL_EXCETO_SE_ENQUADRADO_EM_UMA_DAS_DEMAIS_CATEGORIAS_DE_CONTRIBUINTE_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_PASSAGEIROS – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_CARGA – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_COM_FGTS – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_SEM_FGTS – CONTRIBUINTE_INDIVIDUAL_EMPRESARIOS_SOCIOS_E_MEMBRO_DE_CONSELHO_DE_ADMINISTRACAO_OU_FISCAL – CONTRIBUINTE_INDIVIDUAL_COOPERADO_QUE_PRESTA_SERVICOS_A_EMPRESA_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_COOPERADO_QUE_PRESTA_SERVICOS_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_COOPERADO_FILIADO_A_COOPERATIVA_DE_PRODUCAO – CONTRIBUINTE_INDIVIDUAL_MICRO_EMPREENDEDOR_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_MAGISTRADO_CLASSISTA_TEMPORARIO_DA_JUSTICA_DO_TRABALHO_OU_DA_JUSTICA_ELEITORAL_QUE_SEJA_APOSENTADO_DE_QUALQUER_REGIME_PREVIDENCIARIO – CONTRIBUINTE_INDIVIDUAL_ASSOCIADO_ELEITO_PARA_DIRECAO_DE_COOPERATIVA_ASSOCIACAO_OU_ENTIDADE_DE_CLASSE_DE_QUALQUER_NATUREZA_OU_FINALIDADE_BEM_COMO_O_SINDICO_OU_ADM_DESDE_QUE_RECEBAM_REMUNERACAO – CONTRIBUINTE_INDIVIDUAL_MEMBRO_DE_CONSELHO_TUTELAR_NOS_TERMOS_DA_LEI_N_8_069_DE_13_DE_JULHO_DE_1990 – MINISTRO_DE_CONFISSAO_RELIGIOSA_OU_MEMBRO_DE_VIDA_CONSAGRADA_DE_CONGREGACAO_OU_DE_ORDEM_RELIGIOSA – ESTAGIARIO – MEDICO_RESIDENTE – BOLSISTA_NOS_TERMOS_DA_LEI_8958_1994 – PARTICIPANTE_DE_CURSO_DE_FORMACAO_COMO_ETAPA_DE_CONCURSO_PUBLICO_SEM_VINCULO_DE_EMPREGO_ESTATUTARIO – ATLETA_NAO_PROFISSIONAL_EM_FORMACAO_QUE_RECEBA_BOLSA – BENEFICIARIO_ENTE_PUBLICO – BENEFICIARIO_ENTE_PUBLICO_SOMENTE_CADASTRO_BENEFICIO – DEMITIDO_COM_DATA_ANTERIOR_A_SUCESSAO_CATEGORIA_EXCLUSIVA_SENIOR – NAO_SE_APLICA companyType: description: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVE – DOMESTIC_WORKER – EMPLOYER_ESOCIAL emailType: description: type: string enum: – PERSONAL – PROFESSIONAL stabilityType: description: Tipo de estabilidade type: string enum: – NOT_STABLE – ELECTED_CIPA – WORK_ACCIDENT – MATERNITY_ASSISTANCE – MILITARY_SERVICE – UNION_MANDATE – GOVERNMENT_EMPLOYEE – RETURN_HOLIDAYS – SICK_PAY – NEAR_RETIREMENT – COLLECTIVE_AGREEMENT – PREVIOUS_TIME_FGTS_OPTION – NOT_OPTING_FGTS – CIPA_EMPLOYER – MEMBER_OF_COMISSION_FOR_PRIOR_CONCILIATION – MEMBER_OF_FGTS_CURATOR_COUNCIL – MEMBER_OF_NATIONAL_COUNCIL_OF_SOCIAL_SECURITY – EDUCATION_AID – CONSUMER_COOPERATIVE – CREDIT_UNION – PERSON_WITH_DISABILITY – COOPERATIVE_OF_SYNDICATE – CIPATR – PATERNITY_LEAVE – ELECTORAL_MANDATE – CIPA_CANDIDATE – ELECT_ALTERNATE_CIPA – OTHER – ELECTED_EMPLOYEE_REPRESENTATIVES_COMMITTEE – JOURNEY_REDUCTION_COVID_19_25_50 – JOURNEY_REDUCTION_COVID_19_50_70 – JOURNEY_REDUCTION_COVID_19_70 – TEMPORARY_SUSPENSION_COVID_19 – GESTATION_PERIOD userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: DTO do Health Check type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status educationDegreeRecord: description: Grau de Educação type: object properties: id: type: string maxLength: 32 description: ID grau de educação name: type: string maxLength: 255 description: Nome Grau de Educação code: type: integer format: int64 description: Código de Grau de Instrução addressRecord: description: Endereço type: object required: – additional – neighborhood – address – city properties: id: type: string maxLength: 32 description: ID do endereço additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string maxLength: 255 description: Bairro/Distrito a qual pertence este endereço address: type: string maxLength: 255 description: Logradouro/Rua a qual pertence este endereço city: type: object allOf: – #/definitions/cityRecord description: Cidade a qual pertence este endereço cityRecord: description: Cidade type: object required: – name – state – code properties: id: type: string maxLength: 32 description: ID da Cidade name: type: string maxLength: 255 description: Nome da Cidade state: type: object allOf: – #/definitions/stateRecord description: Estado code: type: integer format: int64 description: Código G5 stateRecord: description: Estado type: object required: – abbreviation – name – code properties: id: type: string maxLength: 32 description: ID do Estado abbreviation: type: string description: Sigla name: type: string description: Nome do Estado code: type: integer format: int64 description: Código G5 nationalityRecord: description: Nacionalidade type: object properties: id: type: string maxLength: 32 description: ID Nacionalidade name: type: string description: Nome Nacionalidade code: type: integer format: int64 description: Código G5 personRecord: description: Pessoa type: object required: – firstname – lastname – socialName – nickname – gender – maritalstatus – race – nationality – educationDegree – naturality properties: id: type: string maxLength: 32 description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa birthday: type: string format: date description: Data de nascimento da pessoa gender: type: string allOf: – #/definitions/genderType description: Gênero da pessoa (Sexo) maritalstatus: type: string allOf: – #/definitions/maritalStatusType description: Estado Cívil da Pessoa race: type: string allOf: – #/definitions/racialType description: Raça cpf: type: string maxLength: 32 description: CPF (Cadastro de Pessoas Físicas) da pessoa nationality: type: object allOf: – #/definitions/nationality description: Nacionalidade educationDegree: type: object allOf: – #/definitions/educationDegree description: Grau de instrução da pessoa addresses: type: array items: type: string description: Endereço da pessoa phoneContacts: type: array items: type: object allOf: – #/definitions/phoneContact description: Telefones de contato da pessoa disabilities: type: array items: type: object allOf: – #/definitions/personDisability description: Deficiências da pessoa nis: type: array items: type: object allOf: – #/definitions/nis description: Documentos NIS da pessoa emails: type: array items: type: object allOf: – #/definitions/email description: Emails da pessoa naturality: type: object allOf: – #/definitions/city description: Naturalidade da pessoa nisRecord: description: Programa Integração Social (pis) type: object properties: id: type: string maxLength: 32 description: Id do documento number: type: string description: Número do documento registrationDate: type: string format: date description: Data re registro do documento person: type: array items: type: object allOf: – #/definitions/person description: Portador do documento emailRecord: description: Email da pessoa type: object required: – email – emailType properties: id: type: string maxLength: 32 description: ID do email email: type: string description: Email da pessoa emailType: type: string allOf: – #/definitions/emailType description: Tipo de email person: type: object allOf: – #/definitions/person description: Portador do e-mail phoneContactRecord: description: TelefoneContato type: object required: – carrier – countryCode – localCode – number – extention – phoneContactType properties: id: type: string maxLength: 32 description: ID do telefone de contato carrier: type: string description: Operador countryCode: type: integer format: int64 description: Código do País localCode: type: integer format: int64 description: DDD number: type: string description: Número extention: type: string description: extensão phoneContactType: type: string allOf: – #/definitions/phoneContactType description: tipo do contato person: type: array items: type: object allOf: – #/definitions/person description: Portador do contato disabilityRecord: description: Deficiências type: object required: – code – name – type properties: id: type: string maxLength: 32 description: ID da entidade code: type: integer format: int64 description: Código da deficiência name: type: string description: Nome da deficiência type: type: string allOf: – #/definitions/disabilityType description: Tipo da deficiência personDisabilityRecord: description: PessoaDeficiencia type: object required: – person – disability – mainDisability – isRehabilitated – dateWhen properties: id: type: string maxLength: 32 description: ID da entidade person: type: object allOf: – #/definitions/personRecord description: Pessoa que possui a deficiência disability: type: object allOf: – #/definitions/disabilityRecord description: Dados da deficiência mainDisability: type: boolean description: Deficiência principal isRehabilitated: type: boolean description: é uma pessoa reabilitada dateWhen: type: string format: date description: Data da deficiência employeeRecord: description: Colaborador type: object required: – contractType – hireDate – dismissalDate – employeeType – registerNumber – employmentrelationshiptype – jobPosition – department – costCenter – workShift – employer – person properties: id: type: string maxLength: 32 description: ID do Colaborador contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato do colaborador hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de demissão employeeType: type: integer format: int64 description: Tipo do colaborador registerNumber: type: integer format: int64 description: Número da matrícula na G5 (numcad) employmentrelationshiptype: type: string allOf: – #/definitions/employmentRelationshipType description: Tipo de relação de colaborador jobPosition: type: object allOf: – #/definitions/jobPositionRecord description: Cargo department: type: object allOf: – #/definitions/departmentRecord description: Departamento costCenter: type: object allOf: – #/definitions/costCenterRecord description: Centro de Custo workShift: type: object allOf: – #/definitions/workShiftRecord description: Turno de trabalho employer: type: object allOf: – #/definitions/companyRecord description: Empregador person: type: object allOf: – #/definitions/personRecord description: Dados da pessoa vinculada ao colaborador emails: type: array items: type: object allOf: – #/definitions/employeeEmailRecord description: Emails vinculado ao colaborador phoneContacts: type: array items: type: object allOf: – #/definitions/phoneContact description: Telefones de contato do colaborador historicStability: type: array items: type: object allOf: – #/definitions/historicStability description: Histórico de estabilidade departmentRecord: description: departamento type: object properties: id: type: string maxLength: 32 description: ID Departamento tableCode: type: integer format: int64 description: Tabela de organograma code: type: string description: Código G5 do departamento/local (codloc) position: type: string description: Posição name: type: string description: Nome do departamento address: type: object allOf: – #/definitions/address description: Endereço creationDate: type: string format: date description: Data de criação expirationDate: type: string format: date description: Data de expiração historicExpirationDate: type: string format: date description: Histórico data de expiração workShiftRecord: description: turno de trabalho type: object required: – name – codesc – workload properties: id: type: string maxLength: 32 description: ID do turno name: type: string description: Descrição do turno codesc: type: integer format: int64 description: Código do turno workload: type: integer format: int64 description: Carga horária do turno (em min/mês) jobPositionRecord: description: Cargo de trabalho type: object required: – codcar properties: id: type: string maxLength: 32 description: ID do Cargo name: type: string description: Nome do cargo codcar: type: string description: Código do Cargo companyRecord: description: Empresa type: object properties: id: type: string maxLength: 32 description: ID da empresa numemp: type: integer format: int64 description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da matriz cnpj: type: string description: CNPJ companyType: type: string allOf: – #/definitions/companyType description: Tipo da empresa cnae: type: string description: CNAE da matriz address: type: object allOf: – #/definitions/address description: Endereço da matriz headquarter: type: object allOf: – #/definitions/company description: Matriz costCenterRecord: description: Centro de Custo type: object required: – codccu properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo workstationRecord: description: Posto de trabalho type: object required: – id – occupant – workstationGroup properties: id: type: string maxLength: 32 description: ID da entidade occupant: type: object allOf: – #/definitions/employeeRecord description: Dados do colaborador workstationGroup: type: object allOf: – #/definitions/workstationGroupRecord description: Grupo de postos de trabalho workstationGroupRecord: description: Grupo posto trabalho type: object required: – id – postra properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do grupo de trabalho postra: type: string description: Código do posto de Trabalho employeeEmailRecord: description: Email colaborador type: object required: – id – email properties: id: type: string maxLength: 32 description: ID do email employee: type: object allOf: – #/definitions/employeeRecord description: Colaborador a quem pertence o email email: type: string description: E-mail da pessoal vinculada hierarchyItemRecord: description: Item Hierarquia type: object required: – id – parent – workstation properties: id: type: string maxLength: 32 description: ID do item parent: type: object allOf: – #/definitions/hierarchyItemRecord description: Superior workstation: type: object allOf: – #/definitions/workstationRecord description: Posto de trabalho educationDegree: description: Grau de Educação type: object properties: id: type: string maxLength: 32 description: ID grau de educação name: type: string maxLength: 255 description: Nome Grau de Educação code: type: integer format: int64 description: Código de Grau de Instrução address: description: Endereço type: object required: – additional – neighborhood – address – city properties: id: type: string maxLength: 32 description: ID do endereço additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string maxLength: 255 description: Bairro/Distrito a qual pertence este endereço address: type: string maxLength: 255 description: Logradouro/Rua a qual pertence este endereço city: type: object allOf: – #/definitions/city description: Cidade a qual pertence este endereço person: type: array items: type: object allOf: – #/definitions/person description: Pessoa a quem pertence o endereço city: description: Cidade type: object required: – name – state – code properties: id: type: string maxLength: 32 description: ID da Cidade name: type: string maxLength: 255 description: Nome da Cidade state: type: object allOf: – #/definitions/state description: Estado code: type: integer format: int64 description: Código G5 state: description: Estado type: object required: – abbreviation – name – code properties: id: type: string maxLength: 32 description: ID do Estado abbreviation: type: string description: Sigla name: type: string description: Nome do Estado code: type: integer format: int64 description: Código G5 nationality: description: Nacionalidade type: object properties: id: type: string maxLength: 32 description: ID Nacionalidade name: type: string description: Nome Nacionalidade code: type: integer format: int64 description: Código G5 person: description: Pessoa type: object required: – firstname – lastname – socialName – nickname – gender – maritalstatus – race – nationality – educationDegree – naturality properties: id: type: string maxLength: 32 description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa birthday: type: string format: date description: Data de nascimento da pessoa gender: type: string allOf: – #/definitions/genderType description: Gênero da pessoa (Sexo) maritalstatus: type: string allOf: – #/definitions/maritalStatusType description: Estado Cívil da Pessoa race: type: string allOf: – #/definitions/racialType description: Raça cpf: type: string maxLength: 32 description: CPF (Cadastro de Pessoas Físicas) da pessoa nationality: type: object allOf: – #/definitions/nationality description: Nacionalidade educationDegree: type: object allOf: – #/definitions/educationDegree description: Grau de instrução da pessoa phoneContact: type: array items: type: object allOf: – #/definitions/phoneContact description: Contatos telefônicos addresses: type: array items: type: object allOf: – #/definitions/address description: Endereços disabilities: type: array items: type: object allOf: – #/definitions/personDisability description: Deficiências nis: type: array items: type: object allOf: – #/definitions/nis description: Documentos NIS da pessoa emails: type: array items: type: object allOf: – #/definitions/email description: Emails da pessoa naturality: type: object allOf: – #/definitions/city description: Naturalidade da pessoa nis: description: Programa Integração Social (pis) type: object properties: id: type: string maxLength: 32 description: ID do documento number: type: string description: Número do documento registrationDate: type: string format: date description: Data re registro do documento person: type: array items: type: object allOf: – #/definitions/person description: Portador do documento email: description: E-mail da pessoa type: object required: – email – emailType properties: id: type: string maxLength: 32 description: ID do email email: type: string description: E-mail da pessoa emailType: type: string allOf: – #/definitions/emailType description: Tipo de email person: type: object allOf: – #/definitions/person description: Portador do e-mail phoneContact: description: TelefoneContato type: object required: – carrier – countryCode – localCode – number – extention – phoneContactType properties: id: type: string maxLength: 32 description: ID do telefone de contato carrier: type: string description: Operador countryCode: type: integer format: int64 description: Código do País localCode: type: integer format: int64 description: DDD number: type: string description: Número extention: type: string description: extensão phoneContactType: type: string allOf: – #/definitions/phoneContactType description: tipo do contato person: type: array items: type: object allOf: – #/definitions/person description: Portador do contato disability: description: Deficiências type: object required: – code – name – type properties: id: type: string maxLength: 32 description: ID da entidade code: type: integer format: int64 description: Código da deficiência name: type: string description: Nome da deficiência type: type: string allOf: – #/definitions/disabilityType description: Tipo da deficiência personDisability: description: PessoaDeficiencia type: object required: – person – disability – mainDisability – isRehabilitated – dateWhen properties: id: type: string maxLength: 32 description: ID da entidade person: type: object allOf: – #/definitions/person description: Pessoa que possui a deficiência disability: type: object allOf: – #/definitions/disability description: Dados da deficiência mainDisability: type: boolean description: Deficiência principal isRehabilitated: type: boolean description: é uma pessoa reabilitada dateWhen: type: string format: date description: Data da deficiência employee: description: Colaborador type: object required: – contractType – hireDate – dismissalDate – employeeType – employmentrelationshiptype – jobPosition – department – costCenter – workShift – employer – person properties: id: type: string maxLength: 32 description: ID do Colaborador contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato do colaborador hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de demissão employeeType: type: integer format: int64 description: Tipo do colaborador registerNumber: type: integer format: int64 description: Número da matrícula na G5 (numcad) employmentrelationshiptype: type: string allOf: – #/definitions/employmentRelationshipType description: Tipo de relação de colaborador jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo department: type: object allOf: – #/definitions/department description: Departamento costCenter: type: object allOf: – #/definitions/costCenter description: Centro de Custo workShift: type: object allOf: – #/definitions/workShift description: Turno de trabalho employer: type: object allOf: – #/definitions/company description: Empregador person: type: object allOf: – #/definitions/person description: Dados da pessoa vinculada ao colaborador phoneContacts: type: array items: type: object allOf: – #/definitions/phoneContact description: Telefones de contato do colaborador emails: type: array items: type: object allOf: – #/definitions/employeeEmail description: Emails vinculado ao colaborador workstation: type: object allOf: – #/definitions/workstation description: Posto de trabalho historicStability: type: array items: type: object allOf: – #/definitions/historicStability description: Histórico de estabilidade department: description: departamento type: object properties: id: type: string maxLength: 32 description: ID Departamento tableCode: type: integer format: int64 description: Código da tabela position: type: string description: Posição code: type: string description: Código G5 do departamento/local (codloc) name: type: string description: Nome do departamento creationDate: type: string format: date description: Data de criação expirationDate: type: string format: date description: Data de expiração historicExpirationDate: type: string format: date description: Histórico data de expiração address: type: object allOf: – #/definitions/address description: Endereço workShift: description: turno de trabalho type: object required: – name – codesc – workload properties: id: type: string maxLength: 32 description: ID do turno name: type: string description: Descrição do turno codesc: type: integer format: int64 description: Código do turno workload: type: integer format: int64 description: Carga horária do turno (em min/mês) jobPosition: description: Cargo de trabalho type: object required: – codcar properties: id: type: string maxLength: 32 description: ID do Cargo name: type: string description: Nome do cargo codcar: type: string description: Código do Cargo company: description: Empresa type: object properties: id: type: string maxLength: 32 description: ID da empresa numemp: type: integer format: int64 description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da matriz cnpj: type: string description: CNPJ companyType: type: string allOf: – #/definitions/companyType description: Tipo da empresa cnae: type: string description: CNAE da matriz address: type: object allOf: – #/definitions/address description: Endereço da matriz headquarter: type: object allOf: – #/definitions/company description: Matriz companyBranches: type: array items: type: object allOf: – #/definitions/company description: Filial costCenter: description: Centro de Custo type: object required: – codccu properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo company: type: object allOf: – #/definitions/company description: Empresa creationDate: type: string format: date description: Data de Criação expirationDate: type: string format: date description: Data de expiração descriptionCode: type: string description: descrição de código workstation: description: Posto de trabalho type: object required: – id – workstationGroup – employee properties: id: type: string maxLength: 32 description: ID da entidade workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho employee: type: string maxLength: 32 description: ID do colaborador deste posto de trabalho hierarchyItem: type: array items: type: object allOf: – #/definitions/hierarchyItem description: Posição do posto na hierarquia workstationGroup: description: Grupo posto trabalho type: object required: – id – postra properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do grupo de trabalho postra: type: string description: Código do posto de Trabalho employeeEmail: description: Email colaborador type: object required: – id – email properties: id: type: string maxLength: 32 description: ID do email employee: type: object allOf: – #/definitions/employee description: Colaborador a quem pertence o email email: type: string description: E-mail da pessoal vinculada hierarchyItem: description: Item Hierarquia type: object required: – id properties: id: type: string maxLength: 32 description: ID do item parent: type: object allOf: – #/definitions/hierarchyItem description: Superior historicStability: description: Histórico de estabilidade type: object required: – id – startDate – endDate – stabilityType – employee properties: id: type: string maxLength: 32 description: Identificador do histórico de estabilidade startDate: type: string format: date description: Data de início da estabilidade endDate: type: string format: date description: Data final da estabilidade stabilityType: type: string allOf: – #/definitions/stabilityType description: Tipo de estabilidade employee: type: string maxLength: 32 description: ID do colaborador deste histórico 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