2.0info: 0.0.1 remuneration_batch description: x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: remuneration_batch contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/remuneration_batchsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /healthcheck: post: description: HealthCheck Plataforma x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/healthCheckStatus checks: #/definitions/checkDTO default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/healthCheckStatus checks: #/definitions/checkDTO default: description: Error response schema: #/definitions/genericError /requestUploadFile: post: description: Solicitação para realizar o upload de um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. default: description: Error response schema: #/definitions/genericError /deleteFile: post: description: Solicitação para apagar um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /requestAccessFile: post: description: Solicitação para acessar um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) ttl: type: integer description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/requestAccessData default: description: Error response schema: #/definitions/genericError /commitFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /importData: post: description: Realiza o processo de importação de um recurso de dados para uma tabela específica x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – resourceId – resourceType – targetType properties: resourceId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. resourceType: #/definitions/resourceType targetType: #/definitions/targetType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: resourceType: type: string enum: – CSV_FILE targetType: type: string enum: – ICP_BONUS – ICP_COMISSION – ICP_CASHHANDLINGBONUS – ICP_LONGSERVICEBONUS – ICP_PPLR – ICP_GRATIFICATION healthCheckStatus: type: string enum: – UP – DOWN checkDTO: type: object required: – name – status properties: name: type: string description: Nome do status status: #/definitions/healthCheckStatus requestAccessData: type: object required: – ok – locationURI properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno locationURI: type: string description: URI onde o arquivo está disponível para download resultBaseData: type: object required: – ok properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno 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