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

benefits

15 views 0 30/04/2026 Atualizado em 07/05/2026 integrador

2.0info: 2.0.2 benefits x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: benefits 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: /benefits/queries/getDashboardBenefits: post: description: Obtém os benefícios disponíveis para o dashboard tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/dashboardBenefits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os benefícios disponíveis para o dashboard tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/dashboardBenefits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/createTransportBenefitRequest: post: description: Cria uma nova requisição de benefício de vale-transporte tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/benefitRequestInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/benefitRequestOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/listTransportPolicies: post: description: Lista as políticas de vale-transporte tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transportPolicyFilter responses: 200: description: Ok schema: type: object allOf: – #/definitions/transportPolicyListOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/saveTransportPolicy: post: description: Salva ou atualiza uma política de vale-transporte tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transportPolicyInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/transportPolicyOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/benefitRequestsCountByType: post: description: Retorna a contagem de solicitações por status tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/benefitRequestsCountByTypeOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a contagem de solicitações por status tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/benefitRequestsCountByTypeOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/getActiveBenefits: post: description: Obtém os benefícios ativos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Código do colaborador para filtrar os benefícios ativos responses: 200: description: Ok schema: type: object required: – activeBenefits properties: activeBenefits: type: array items: type: object allOf: – #/definitions/activeBenefitItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os benefícios ativos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Código do colaborador para filtrar os benefícios ativos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – activeBenefits properties: activeBenefits: type: array items: type: object allOf: – #/definitions/activeBenefitItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/queries/benefitRequests: post: description: Lista as solicitações de benefícios com os dados do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/benefitRequestsFilter responses: 200: description: Ok schema: type: object allOf: – #/definitions/benefitRequestsPagedOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/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 /benefits/queries/exportBenefit: 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 /benefits/queries/exportTransportPolicy: 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 /benefits/queries/exportPolicyCompany: 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 /benefits/queries/exportBenefitRequest: 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 /benefits/queries/exportMeansTransportRequest: 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 /benefits/queries/exportTransportCard: 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 /benefits/queries/exportTransportDetail: 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 /benefits/queries/exportHealthPolicy: 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 /benefits/queries/exportHealthPolicyOperator: 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 /benefits/queries/exportHealthPolicyKinship: 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 /benefits/queries/exportHealthPolicyContractType: 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 /benefits/queries/exportHealthPolicyDocument: 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 /benefits/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 /benefits/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/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: HealthCheck plataforma 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 /benefits/actions/handleTransportationBenefitRequest: post: description: Cria ou recusa uma requisição de benefício de vale-transporte tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – benefitRequestId – benefitAction properties: benefitRequestId: type: string description: Id da requisição de benefício transportationVoucherScaleId: type: string description: Id da escala de vale-transporte (necessário para aprovação) description: type: string description: Descrição benefitAction: type: string allOf: – #/definitions/benefitAction description: Ação a ser tomada responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/actions/changeBenefitStatus: post: description: Altera o status de um benefício específico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – benefitType – status properties: benefitType: type: string allOf: – #/definitions/benefitType description: Id do benefício status: type: string allOf: – #/definitions/statusTypes description: Novo status do benefício responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/actions/importBenefit: 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 /benefits/actions/importTransportPolicy: 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 /benefits/actions/importPolicyCompany: 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 /benefits/actions/importBenefitRequest: 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 /benefits/actions/importMeansTransportRequest: 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 /benefits/actions/importTransportCard: 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 /benefits/actions/importTransportDetail: 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 /benefits/actions/importHealthPolicy: 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 /benefits/actions/importHealthPolicyOperator: 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 /benefits/actions/importHealthPolicyKinship: 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 /benefits/actions/importHealthPolicyContractType: 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 /benefits/actions/importHealthPolicyDocument: 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 /benefits/signals/handleTransportationBenefitRequestAsync: post: description: Cria ou recusa uma requisição de benefício de vale-transporte de forma assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – benefitRequestId – approvedBy properties: benefitRequestId: type: string description: Id da requisição de benefício approvedBy: type: string description: Id do colaborador que está aprovando a solicitação approvedByUsername: type: string description: Username (login) do usuário da plataforma que está aprovando a solicitação transportationVoucherScaleId: type: string description: Id da escala de vale-transporte (necessário para aprovação) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /benefits/events/importBenefitEvent: 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 /benefits/events/exportBenefitEvent: 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 /benefits/events/importTransportPolicyEvent: 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 /benefits/events/exportTransportPolicyEvent: 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 /benefits/events/importPolicyCompanyEvent: 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 /benefits/events/exportPolicyCompanyEvent: 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 /benefits/events/importBenefitRequestEvent: 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 /benefits/events/exportBenefitRequestEvent: 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 /benefits/events/importMeansTransportRequestEvent: 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 /benefits/events/exportMeansTransportRequestEvent: 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 /benefits/events/importTransportCardEvent: 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 /benefits/events/exportTransportCardEvent: 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 /benefits/events/importTransportDetailEvent: 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 /benefits/events/exportTransportDetailEvent: 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 /benefits/events/importHealthPolicyEvent: 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 /benefits/events/exportHealthPolicyEvent: 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 /benefits/events/importHealthPolicyOperatorEvent: 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 /benefits/events/exportHealthPolicyOperatorEvent: 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 /benefits/events/importHealthPolicyKinshipEvent: 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 /benefits/events/exportHealthPolicyKinshipEvent: 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 /benefits/events/importHealthPolicyContractTypeEvent: 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 /benefits/events/exportHealthPolicyContractTypeEvent: 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 /benefits/events/importHealthPolicyDocumentEvent: 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 /benefits/events/exportHealthPolicyDocumentEvent: 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 /benefits/entities/benefit: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/benefit responses: 200: description: The created resource schema: #/definitions/benefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/benefit responses: 200: description: The created resource schema: #/definitions/benefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/benefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/benefit/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editBenefit responses: 200: description: Ok schema: #/definitions/editBenefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/benefit responses: 200: description: Ok schema: #/definitions/benefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/benefit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/benefit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/benefit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportPolicy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportPolicy responses: 200: description: The created resource schema: #/definitions/transportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportPolicy responses: 200: description: The created resource schema: #/definitions/transportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/transportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportPolicy/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTransportPolicy responses: 200: description: Ok schema: #/definitions/editTransportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/transportPolicy responses: 200: description: Ok schema: #/definitions/transportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/transportPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportPolicy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/transportPolicy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/policyCompany: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/policyCompany responses: 200: description: The created resource schema: #/definitions/policyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/policyCompany responses: 200: description: The created resource schema: #/definitions/policyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/policyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/policyCompany/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPolicyCompany responses: 200: description: Ok schema: #/definitions/editPolicyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/policyCompany responses: 200: description: Ok schema: #/definitions/policyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/policyCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/policyCompany/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/policyCompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/benefitRequest: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/benefitRequest responses: 200: description: The created resource schema: #/definitions/benefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/benefitRequest responses: 200: description: The created resource schema: #/definitions/benefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/benefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/benefitRequest/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editBenefitRequest responses: 200: description: Ok schema: #/definitions/editBenefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/benefitRequest responses: 200: description: Ok schema: #/definitions/benefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/benefitRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/benefitRequest/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/benefitRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/meansTransportRequest: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/meansTransportRequest responses: 200: description: The created resource schema: #/definitions/meansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/meansTransportRequest responses: 200: description: The created resource schema: #/definitions/meansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/meansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/meansTransportRequest/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editMeansTransportRequest responses: 200: description: Ok schema: #/definitions/editMeansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/meansTransportRequest responses: 200: description: Ok schema: #/definitions/meansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/meansTransportRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/meansTransportRequest/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/meansTransportRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportCard: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportCard responses: 200: description: The created resource schema: #/definitions/transportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportCard responses: 200: description: The created resource schema: #/definitions/transportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/transportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportCard/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTransportCard responses: 200: description: Ok schema: #/definitions/editTransportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/transportCard responses: 200: description: Ok schema: #/definitions/transportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/transportCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportCard/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/transportCard responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportDetail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportDetail responses: 200: description: The created resource schema: #/definitions/transportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transportDetail responses: 200: description: The created resource schema: #/definitions/transportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/transportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportDetail/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTransportDetail responses: 200: description: Ok schema: #/definitions/editTransportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/transportDetail responses: 200: description: Ok schema: #/definitions/transportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/transportDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/transportDetail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/transportDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicy responses: 200: description: The created resource schema: #/definitions/healthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicy responses: 200: description: The created resource schema: #/definitions/healthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/healthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicy/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHealthPolicy responses: 200: description: Ok schema: #/definitions/editHealthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/healthPolicy responses: 200: description: Ok schema: #/definitions/healthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/healthPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/healthPolicy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyOperator: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyOperator responses: 200: description: The created resource schema: #/definitions/healthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyOperator responses: 200: description: The created resource schema: #/definitions/healthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/healthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyOperator/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHealthPolicyOperator responses: 200: description: Ok schema: #/definitions/editHealthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/healthPolicyOperator responses: 200: description: Ok schema: #/definitions/healthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/healthPolicyOperator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyOperator/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/healthPolicyOperator responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyKinship: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyKinship responses: 200: description: The created resource schema: #/definitions/healthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyKinship responses: 200: description: The created resource schema: #/definitions/healthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/healthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyKinship/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHealthPolicyKinship responses: 200: description: Ok schema: #/definitions/editHealthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/healthPolicyKinship responses: 200: description: Ok schema: #/definitions/healthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/healthPolicyKinship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyKinship/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/healthPolicyKinship responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyContractType: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyContractType responses: 200: description: The created resource schema: #/definitions/healthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyContractType responses: 200: description: The created resource schema: #/definitions/healthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/healthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyContractType/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHealthPolicyContractType responses: 200: description: Ok schema: #/definitions/editHealthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/healthPolicyContractType responses: 200: description: Ok schema: #/definitions/healthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/healthPolicyContractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyContractType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/healthPolicyContractType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyDocument responses: 200: description: The created resource schema: #/definitions/healthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/healthPolicyDocument responses: 200: description: The created resource schema: #/definitions/healthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/healthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHealthPolicyDocument responses: 200: description: Ok schema: #/definitions/editHealthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/healthPolicyDocument responses: 200: description: Ok schema: #/definitions/healthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/healthPolicyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /benefits/entities/healthPolicyDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/healthPolicyDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: benefitType: type: string enum: – TRANSPORT – HEALTH statusTypes: type: string enum: – ACTIVE – INACTIVE – PENDING – APPROVED – REJECTED – CANCELED – PROCESSING – AVAILABLE requestType: type: string enum: – ENROLLMENT – CANCELLATION – UPDATE directionType: type: string enum: – ASC – DESC description: Tipo de ordenação: * `ASC` – Ascendente * `DESC` – Descendente benefitAction: type: string enum: – APPROVE – REJECT description: Ação para requisição de benefício: * `APPROVE` – Aprovar * `REJECT` – Rejeitar userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim activeBenefitItem: description: type: object required: – benefitType – benefitInfo – status properties: benefitType: type: string allOf: – #/definitions/benefitType description: Tipo do benefício benefitInfo: type: string description: Informação do benefício status: type: string allOf: – #/definitions/statusTypes description: Status da solicitação (AVAILABLE quando o colaborador ainda não solicitou) comment: type: string description: Comentário da solicitação benefitRequestInput: description: type: object required: – requestType properties: transports: type: array items: type: object allOf: – #/definitions/transportRequestItem description: Lista de meios de transporte com suas informações description: type: string description: Descrição requestType: type: string allOf: – #/definitions/requestType description: Tipo da solicitação transportRequestItem: description: type: object required: – meansOfTransportId – passes properties: meansOfTransportId: type: string description: ID do meio de transporte passes: type: integer format: int64 description: Quantidade de passes transportCard: type: string description: Lista de carteirinhas de transporte benefitRequestOutput: description: type: object required: – id – message properties: id: type: string description: Id da requisição criada message: type: string description: Mensagem de sucesso transportPolicyFilter: description: type: object required: – page properties: status: type: string allOf: – #/definitions/statusTypes description: Filtro por status (se não informado, traz todos os registros) page: type: object allOf: – #/definitions/pagination description: Paginação orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação pagination: description: type: object required: – offset – size properties: offset: type: integer format: int64 description: Página de inicio minimum: 0 size: type: integer format: int64 description: Quantidade de páginas minimum: 1 maximum: 100 ordination: description: type: object required: – field properties: field: type: string description: Campo que será ordenado order: type: string allOf: – #/definitions/directionType description: Tipo da ordenação transportPolicyListOutput: description: allOf: – #/definitions/paged – type: object required: – policies properties: policies: type: array items: type: object allOf: – #/definitions/transportPolicyItem minimum: 1 description: Lista de políticas de transporte paged: description: discriminator: _discriminator type: object required: – totalElements – numberPages – _discriminator properties: totalElements: type: integer format: int64 description: Indica quantos registros foram encontrados numberPages: type: integer format: int64 description: Indica o número de páginas da consulta (incluindo a atual) _discriminator: type: string description: transportPolicyItem: description: type: object required: – id – company – branches – policyName – startDate – status properties: id: type: string description: Id da política company: type: string description: Empresa branches: type: array items: type: string minimum: 1 description: Filiais policyName: type: string description: Nome da política startDate: type: string format: date description: Início da vigência endDate: type: string format: date description: Fim da vigência status: type: string allOf: – #/definitions/statusTypes description: Status transportPolicyInput: description: type: object required: – name – company – branches – startDate – enrollmentPeriod – cancelationPeriod – updatePeriod properties: id: type: string description: Id da política (obrigatório para edição, opcional para criação) name: type: string description: Nome da política company: type: string description: Código da empresa branches: type: array items: type: string minimum: 1 description: Códigos da filial startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término status: type: string allOf: – #/definitions/statusTypes description: Status da política (se não informado, será ACTIVE) enrollmentPeriod: type: integer format: int64 description: Período de inscrição (em dias) cancelationPeriod: type: integer format: int64 description: Período de cancelamento (em dias) updatePeriod: type: integer format: int64 description: Período de atualização (em dias) policy: type: string description: Política eula: type: string description: Termos de uso transportPolicyOutput: description: type: object required: – id – message properties: id: type: string description: Id da política criada ou atualizada message: type: string description: Mensagem de sucesso dashboardBenefits: description: type: object required: – totalPolicies – totalActivePolicies – totalBeneficiaries – totalRequestInRevision – benefitsInfo properties: totalPolicies: type: integer format: int64 description: Total de políticas totalActivePolicies: type: integer format: int64 description: Total de políticas ativas totalBeneficiaries: type: integer format: int64 description: Total de beneficiários totalRequestInRevision: type: integer format: int64 description: Total em revisão benefitsInfo: type: array items: type: object allOf: – #/definitions/benefitsInfo minimum: 1 description: Informaçoes do benefício benefitsInfo: description: type: object required: – benefitType – name – description – icon – color – status properties: benefitType: type: string allOf: – #/definitions/benefitType description: Tipo do benefício name: type: string description: Nome description: type: string description: Descrição icon: type: string description: Icone color: type: string description: Cor status: type: string allOf: – #/definitions/statusTypes description: status do benefício benefitRequestsCountByTypeOut: description: type: object required: – totalRequests – totalEnrollment – totalUpdate – totalCancellation properties: totalRequests: type: integer format: int64 description: Total de solicitações de benefícios totalEnrollment: type: integer format: int64 description: Total de solicitações para inclusão totalUpdate: type: integer format: int64 description: Total de solicitações para atualização totalCancellation: type: integer format: int64 description: Total de solicitações para exclusão benefitRequestsFilter: description: type: object required: – status – page properties: employeeIds: type: array items: type: string description: Lista de colaboradores status: type: string allOf: – #/definitions/statusTypes description: Status das solicitações page: type: object allOf: – #/definitions/pagination description: Dados de paginação orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Dados de ordenação benefitRequestsPagedOut: description: allOf: – #/definitions/paged – type: object required: – benefitRequests properties: benefitRequests: type: array items: type: object allOf: – #/definitions/benefitRequestWithEmployee minimum: 1 description: benefitRequestWithEmployee: description: type: object required: – benefitRequestId – employeeName – employeeRegisterNumber – branch – company – jobPosition – benefitType – requestType – createdAt properties: benefitRequestId: type: string description: employeeName: type: string description: employeeRegisterNumber: type: string description: branch: type: string description: company: type: string description: jobPosition: type: string description: benefitType: type: string allOf: – #/definitions/benefitType description: requestType: type: string allOf: – #/definitions/requestType description: createdAt: type: string format: date-time description: benefit: description: type: object required: – benefitType – status properties: id: type: string format: uuid description: Id benefitType: type: string allOf: – #/definitions/benefitType description: Tipo do benefício status: type: string allOf: – #/definitions/statusTypes description: status do benefício editBenefit: type: object required: – id allOf: – #/definitions/benefit transportPolicy: description: type: object required: – name – company – startDate – status – createdAt – createdBy properties: id: type: string format: uuid description: Id name: type: string description: Nome da política company: type: string description: empresa startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término status: type: string allOf: – #/definitions/statusTypes description: status da política enrollmentPeriod: type: integer format: int64 description: Período de inscrição (em dias) cancelationPeriod: type: integer format: int64 description: Período de cancelamento (em dias) updatePeriod: type: integer format: int64 description: Período de atualização (em dias) policy: type: string description: Política eula: type: string description: Termos de uso updatedAt: type: string format: date-time description: Data de atualização updatedBy: type: string description: Atualizado por createdAt: type: string format: date-time description: Data de criação createdBy: type: string description: Criado por editTransportPolicy: type: object required: – id allOf: – #/definitions/transportPolicy policyCompany: description: type: object required: – company – transportPolicy properties: id: type: string format: uuid description: Id company: type: string description: Código da filial transportPolicy: type: object allOf: – #/definitions/transportPolicy description: Política de transporte editPolicyCompany: type: object required: – id allOf: – #/definitions/policyCompany benefitRequest: description: type: object required: – employee – requestType – benefitType – status – createdAt properties: id: type: string format: uuid description: Id benefit: type: object allOf: – #/definitions/benefit description: Benefício employee: type: string description: Identificador do colaborador requestType: type: string allOf: – #/definitions/requestType description: Tipo da solicitação benefitType: type: string allOf: – #/definitions/benefitType description: Tipo do benefício status: type: string allOf: – #/definitions/statusTypes description: status da solicitação approvedBy: type: string description: Aprovado por approvedAt: type: string format: date-time description: Data de aprovação comment: type: string description: Comentário createdAt: type: string format: date-time description: Data de criação editBenefitRequest: type: object required: – id allOf: – #/definitions/benefitRequest meansTransportRequest: description: type: object required: – benefitRequest – idMeansOfTransport – passes properties: id: type: string format: uuid description: Id benefitRequest: type: object allOf: – #/definitions/benefitRequest description: Solicitação de benefício idMeansOfTransport: type: string description: Identificador do meio de transporte passes: type: integer format: int64 description: Número de passes editMeansTransportRequest: type: object required: – id allOf: – #/definitions/meansTransportRequest transportCard: description: type: object required: – meansTransportRequest – card properties: id: type: string format: uuid description: Id meansTransportRequest: type: object allOf: – #/definitions/meansTransportRequest description: Solicitação de meio de transporte card: type: string description: Número do cartão editTransportCard: type: object required: – id allOf: – #/definitions/transportCard transportDetail: description: type: object required: – benefitRequest – passes properties: id: type: string format: uuid description: Id benefitRequest: type: object allOf: – #/definitions/benefitRequest description: Solicitação de benefício passes: type: integer format: int64 description: Número de passes description: type: string description: Descrição editTransportDetail: type: object required: – id allOf: – #/definitions/transportDetail healthPolicy: description: type: object required: – name – company – startDate – status – createdAt – createdBy properties: id: type: string format: uuid description: Id name: type: string description: Nome da política de saúde company: type: string description: Empresa startDate: type: string format: date description: Data de início da vigência endDate: type: string format: date description: Data de término da vigência status: type: string allOf: – #/definitions/statusTypes description: Status da política enrollmentPeriod: type: integer format: int64 description: Período de inscrição (em dias) cancelationPeriod: type: integer format: int64 description: Período de cancelamento (em dias) updatePeriod: type: integer format: int64 description: Período de atualização (em dias) minimumAdhesion: type: integer format: int64 description: Adesão mínima (em colaboradores) policy: type: string description: Texto da política eula: type: string description: Termos de uso (EULA) createdAt: type: string format: date-time description: Data de criação createdBy: type: string description: Criado por updatedAt: type: string format: date-time description: Data de atualização updatedBy: type: string description: Atualizado por editHealthPolicy: type: object required: – id allOf: – #/definitions/healthPolicy healthPolicyOperator: description: type: object required: – healthPolicy – operator properties: id: type: string format: uuid description: Id healthPolicy: type: object allOf: – #/definitions/healthPolicy description: Política de saúde operator: type: string format: uuid description: Operadora (referência UUID ao legado) coParticipationPercentage: type: number format: double description: Percentual de co-participação editHealthPolicyOperator: type: object required: – id allOf: – #/definitions/healthPolicyOperator healthPolicyKinship: description: type: object required: – healthPolicy – kinshipId properties: id: type: string format: uuid description: Id healthPolicy: type: object allOf: – #/definitions/healthPolicy description: Política de saúde kinshipId: type: string format: uuid description: Id do grau de parentesco (referência UUID ao legado) editHealthPolicyKinship: type: object required: – id allOf: – #/definitions/healthPolicyKinship healthPolicyContractType: description: type: object required: – healthPolicy – contractTypeId properties: id: type: string format: uuid description: Id healthPolicy: type: object allOf: – #/definitions/healthPolicy description: Política de saúde contractTypeId: type: string format: uuid description: Id do tipo de contrato (referência UUID ao legado) editHealthPolicyContractType: type: object required: – id allOf: – #/definitions/healthPolicyContractType healthPolicyDocument: description: type: object required: – healthPolicy – fileReference – fileName – uploadedAt – uploadedBy properties: id: type: string format: uuid description: Id healthPolicy: type: object allOf: – #/definitions/healthPolicy description: Política de saúde fileReference: type: string description: Referência do arquivo no GED fileName: type: string description: Nome do arquivo uploadedAt: type: string format: date-time description: Data de upload uploadedBy: type: string description: Enviado por editHealthPolicyDocument: type: object required: – id allOf: – #/definitions/healthPolicyDocument 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

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