general

2.0info: 1.10.3 general description: ARP General Backend x-senior-domain: Armazenamento de registro de ponto x-senior-domain-path: arp x-senior-service-path: general 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/arpsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError /general/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 /general/queries/exportPendency: 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 /general/queries/exportEmployer: 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 /general/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 /general/queries/exportDsf: 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 /general/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 /general/actions/createEmployerBulk: post: description: Cria empregadores em lote\n Faz o tratamento se o empredador enviado, já existir outro com o mesmo externalId, faz a atualização do existente.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employers properties: employers: type: array items: type: object allOf: – #/definitions/employerBulkDTO minimum: 1 description: Lista de empregadores responses: 200: description: Ok schema: type: object required: – employers – errors properties: employers: type: array items: type: object allOf: – #/definitions/employerBulkDTO minimum: 1 description: Lista de empregadores inseridos com sucesso errors: type: array items: type: object allOf: – #/definitions/employerBulkError minimum: 1 description: Lista de empregadores não inseridos e os seu respectivos erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateEmployerBulk: post: description: Atualiza empregadores em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employers properties: employers: type: array items: type: object allOf: – #/definitions/employerBulkDTO minimum: 1 description: Lista de empregadores responses: 200: description: Ok schema: type: object required: – employers – errors properties: employers: type: array items: type: object allOf: – #/definitions/employerBulkDTO minimum: 1 description: Lista de empregadores inseridos com sucesso errors: type: array items: type: object allOf: – #/definitions/employerBulkError minimum: 1 description: Lista de empregadores não inseridos e os seu respectivos erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/createEmployeeBulk: post: description: Cria empregados em lote\n Faz o tratamento se o empregado enviado, já existir outro com o mesmo externalId, faz a atualização do existente.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeBulkDTO minimum: 1 description: Lista de empregados responses: 200: description: Ok schema: type: object required: – employees – errors properties: employees: type: array items: type: object allOf: – #/definitions/employeeBulkDTO minimum: 1 description: Lista de empregados inseridos com sucesso errors: type: array items: type: object allOf: – #/definitions/employeeBulkError minimum: 1 description: Lista de empregados não inseridos e os seu respectivos erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateEmployeeBulk: post: description: Atualiza empregados em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeBulkDTO minimum: 1 description: Lista de empregados responses: 200: description: Ok schema: type: object required: – employees – errors properties: employees: type: array items: type: object allOf: – #/definitions/employeeBulkDTO minimum: 1 description: Lista de empregados inseridos com sucesso errors: type: array items: type: object allOf: – #/definitions/employeeBulkError minimum: 1 description: Lista de empregados não inseridos e os seu respectivos erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeBulk: post: description: Remove empregados em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: type: string minimum: 1 description: Lista de ids dos empregados responses: 200: description: Ok schema: type: object required: – employees – errors properties: employees: type: array items: type: string minimum: 1 description: Lista de empregados removidos com sucesso errors: type: array items: type: object allOf: – #/definitions/employeeDeleteBulkError minimum: 1 description: Lista de empregados não removidos e os seu respectivos erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importPendency: 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 /general/actions/importEmployer: 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 /general/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 /general/actions/importDsf: 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 /general/signals/updateArpStatus: post: description: Atualiza o status da ARP\n Esse signal pode ser executado somente via mensageria, a sua requisição via API está bloqueada.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – arpStatusEvent properties: arpStatusEvent: type: object allOf: – #/definitions/arpStatusEvent description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/importPendencyEvent: 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 /general/events/exportPendencyEvent: 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 /general/events/importEmployerEvent: 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 /general/events/exportEmployerEvent: 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 /general/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 /general/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 /general/events/importDsfEvent: 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 /general/events/exportDsfEvent: 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 /general/events/employerFacadeCreated: post: description: Event Create from facade employer x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employerFacade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/apis/employer: post: description: Serviço de fachada para o Empregador tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employerFacade responses: 200: description: Ok schema: #/definitions/employerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço de fachada para o Empregador tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/employer/{id}: get: description: Serviço de fachada para o Empregador tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Serviço de fachada para o Empregador tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/employerFacade responses: 200: description: Ok schema: #/definitions/employerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/employee: post: description: Serviço de fachada para o Empregado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeFacade responses: 200: description: Ok schema: #/definitions/employeeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço de fachada para o Empregado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employeeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/employee/{id}: get: description: Serviço de fachada para o Empregado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Serviço de fachada para o Empregado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/employeeFacade responses: 200: description: Ok schema: #/definitions/employeeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Serviço de fachada para o Empregado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN arpStatus: description: Status da ARP type: string enum: – AVAILABLE – UNAVAILABLE employerType: description: Tipo de empregador type: string enum: – CNPJ – CPF dsfRecordType: description: Tipo de registro type: string enum: – EMPLOYER_UPDATE – REP_CEA_CLOCKING_EVENT – CLOCK_SETTING – EMPLOYEE_UPDATE – REP_EVENT – REP_P_CLOCKING_EVENT employeeOperationType: description: Tipo de operação do empregado type: string enum: – EMPLOYEE_INSERT – EMPLOYEE_UPDATE – EMPLOYEE_DELETE pendencyStatus: description: Status da pendência type: string enum: – WAITING – RUNNING pendencyType: description: Tipo de pendência type: string enum: – NSR 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 healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde arpStatusEvent: description: Evento de atualização de status da ARP type: object required: – date – time – timeZone – arpStatus properties: date: type: string format: date description: Data time: type: string description: Hora timeZone: type: string description: Timezone arpStatus: type: string allOf: – #/definitions/arpStatus description: Status da ARP employerBulkDTO: description: Record para inserir empregador em lote type: object required: – externalId – identifier – employerType – name – registerNumberINPI – address – cpfResponsible properties: id: type: string description: Id externalId: type: string description: Id externo identifier: type: integer format: int64 description: Identificador (CPF ou CNPJ) employerType: type: string allOf: – #/definitions/employerType description: Tipo do empregador nationalRegister: type: integer format: int64 description: Registro nacional name: type: string description: Nome registerNumberINPI: type: string description: Número de registro no INPI address: type: string description: Endereço cpfResponsible: type: integer format: int64 description: CPF do responsável cnoNumber: type: integer format: int64 description: Número de Cadastro Nacional de Obras caepf: type: integer format: int64 description: CAEPF employerBulkError: description: Record para listar os erros da primitiva employerBulk type: object required: – employer – message properties: employer: type: object allOf: – #/definitions/employerBulkDTO description: Empregador message: type: string description: Mensagem de erro employeeBulkDTO: description: Record para inserir empregado em lote type: object required: – externalId – employer – cpf – name – secondaryIdentification – cpfResponsible properties: id: type: string description: Id externalId: type: string description: Id externo employer: type: string description: Empregador cpf: type: integer format: int64 description: CPF name: type: string description: Nome secondaryIdentification: type: string maxLength: 4 description: Identificador secundário cpfResponsible: type: integer format: int64 description: CPF do responsável employeeBulkError: description: Record para listar os erros da primitiva employeeBulk type: object required: – employee – message properties: employee: type: object allOf: – #/definitions/employeeBulkDTO description: Empregado message: type: string description: Mensagem de erro employeeDeleteBulkError: description: Record para listar os erros da primitiva deleteEmployeeBulk type: object required: – employee – message properties: employee: type: string description: Id do Empregado message: type: string description: Mensagem de erro pendency: description: Pendência type: object required: – id – type – status – updateTime – lastCreatedDate properties: id: type: string format: uuid description: Identificador do registro type: type: string allOf: – #/definitions/pendencyType description: Tipo status: type: string allOf: – #/definitions/pendencyStatus description: Status updateTime: type: string format: date-time description: Data da última alteração lastCreatedDate: type: string format: date-time description: Data do último createDate processado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employer: description: Empregador type: object required: – externalId – identifier – employerType – name – registerNumberINPI – address – cpfResponsible – enabled properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo identifier: type: integer format: int64 description: Identificador (CPF ou CNPJ) employerType: type: string allOf: – #/definitions/employerType description: Tipo do empregador nationalRegister: type: integer format: int64 description: Registro nacional name: type: string description: Nome registerNumberINPI: type: string description: Número de registro no INPI address: type: string description: Endereço cpfResponsible: type: integer format: int64 description: CPF do responsável enabled: type: boolean description: Habilitado cnoNumber: type: integer format: int64 description: Número de Cadastro Nacional de Obras caepf: type: integer format: int64 description: CAEPF createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employee: description: Empregado type: object required: – externalId – employer – cpf – name – secondaryIdentification – cpfResponsible – enabled properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo employer: type: string format: uuid description: Empregador cpf: type: integer format: int64 description: CPF name: type: string description: Nome secondaryIdentification: type: string maxLength: 4 description: Identificador secundário cpfResponsible: type: integer format: int64 description: CPF do responsável enabled: type: boolean description: Habilitado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dsf: description: Fonte de dados type: object required: – cpfResponsible – employer – recordType – recordId – recordExternalId – recordLine – version properties: id: type: string format: uuid description: Id cpfResponsible: type: integer format: int64 description: CPF do responsável employer: type: string format: uuid description: Empregador nsr: type: integer format: int64 description: NSR recordType: type: string allOf: – #/definitions/dsfRecordType description: Tipo do registro recordId: type: string format: uuid description: Id do registro recordExternalId: type: string format: uuid description: Id externo recordLine: type: string description: Linha do registro type: integer format: int64 description: Versão hash: type: string description: Hash createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 employerFacade: description: Serviço de fachada para o Empregador type: object required: – externalId – identifier – employerType – name – registerNumberINPI – address – cpfResponsible properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo identifier: type: integer format: int64 description: Identificador (CPF ou CNPJ) employerType: type: string allOf: – #/definitions/employerType description: Tipo do empregador nationalRegister: type: integer format: int64 description: Registro nacional name: type: string description: Nome registerNumberINPI: type: string description: Número de registro no INPI address: type: string description: Endereço cpfResponsible: type: integer format: int64 description: CPF do responsável cnoNumber: type: integer format: int64 description: Número de Cadastro Nacional de Obras caepf: type: integer format: int64 description: CAEPF employeeFacade: description: Serviço de fachada para o Empregado type: object required: – externalId – employer – cpf – name – secondaryIdentification – cpfResponsible properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo employer: type: string format: uuid description: Empregador cpf: type: integer format: int64 description: CPF name: type: string description: Nome secondaryIdentification: type: string maxLength: 4 description: Identificador secundário cpfResponsible: type: integer format: int64 description: CPF do responsável 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