Hcm

catalog

97 views 23/07/2019 10/01/2020 integrador 0

2.0info: 2.3.1 catalog description: Serviço de catálogos de produtos do HCM x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: catalog contact: name: Senior X Platform url: http://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: /catalog/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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados default: description: Error response schema: #/definitions/genericError /catalog/queries/getSchemaNameByShortName: post: description: Retorna o nome do schema através do nome do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – shortName properties: shortName: type: string description: Nome do Tenant responses: 200: description: Ok schema: type: object required: – schemaName properties: schemaName: type: string description: Nome do Schema default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome do schema através do nome do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shortName description: Nome do Tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – schemaName properties: schemaName: type: string description: Nome do Schema default: description: Error response schema: #/definitions/genericError /catalog/queries/getTenantsByModule: post: description: Relaciona os tenants que possuem o módulo instalado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moduleName properties: moduleName: type: string allOf: – #/definitions/moduleDTO description: Nome do módulo responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenantShortDTO minimum: 1 description: Tenants do módulo default: description: Error response schema: #/definitions/genericError /catalog/queries/getTenantsByModulePlatformActive: post: description: Relaciona os tenants que possuem o módulo instalado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moduleName – considerPlatformActiveSituation properties: moduleName: type: string allOf: – #/definitions/moduleDTO description: Nome do módulo considerPlatformActiveSituation: type: boolean description: considerPlatformActiveSituation responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenantShortDTO minimum: 1 description: Tenants do módulo default: description: Error response schema: #/definitions/genericError /catalog/queries/getExistsTenantByModulePlatformActive: post: description: Relaciona os tenants que possuem o módulo instalado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moduleName – considerPlatformActiveSituation – shortName properties: moduleName: type: string allOf: – #/definitions/moduleDTO description: Nome do módulo considerPlatformActiveSituation: type: boolean description: considerPlatformActiveSituation shortName: type: string description: Nome do Tenant responses: 200: description: Ok schema: type: object required: – existsTenantModule properties: existsTenantModule: type: boolean description: Exist Tenant para o módulo default: description: Error response schema: #/definitions/genericError /catalog/queries/getHCMTenant: post: description: Traz os dados da Tenant do tenant específico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantID: type: string description: ID do Tenant shortName: type: string description: Shortname do tenant responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantFullDTO default: description: Error response schema: #/definitions/genericError get: description: Traz os dados da Tenant do tenant específico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantID description: ID do Tenant in: query type: string – name: shortName description: Shortname do tenant in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantFullDTO default: description: Error response schema: #/definitions/genericError /catalog/queries/getAllHCMTenantModules: post: description: Traz todos os Tenants do HCM Em forma Resumida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenantID: type: string description: ID do Tenant shortName: type: string description: Shortname do tenant responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenantmoduleFullDTO minimum: 1 description: Tenants do módulo default: description: Error response schema: #/definitions/genericError get: description: Traz todos os Tenants do HCM Em forma Resumida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantID description: ID do Tenant in: query type: string – name: shortName description: Shortname do tenant in: query type: string responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenantmoduleFullDTO minimum: 1 description: Tenants do módulo default: description: Error response schema: #/definitions/genericError /catalog/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: 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: default: description: Error response schema: #/definitions/genericError /catalog/queries/exportTenant: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /catalog/queries/exportTenantmodule: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /catalog/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /catalog/actions/importTenant: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /catalog/actions/importTenantmodule: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /catalog/entities/tenant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenant responses: 200: description: The created resource schema: #/definitions/tenant 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/tenant responses: 200: description: The created resource schema: #/definitions/tenant 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 responses: 200: description: Ok schema: type: array items: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /catalog/entities/tenant/{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/tenant responses: 200: description: Ok schema: #/definitions/tenant 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/tenant responses: 200: description: Ok schema: #/definitions/tenant 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/tenant 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 default: description: Error response schema: #/definitions/genericError /catalog/entities/tenant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenant responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /catalog/entities/tenantmodule: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantmodule responses: 200: description: The created resource schema: #/definitions/tenantmodule 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/tenantmodule responses: 200: description: The created resource schema: #/definitions/tenantmodule 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 responses: 200: description: Ok schema: type: array items: #/definitions/tenantmodule default: description: Error response schema: #/definitions/genericError /catalog/entities/tenantmodule/{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/tenantmodule responses: 200: description: Ok schema: #/definitions/tenantmodule 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/tenantmodule responses: 200: description: Ok schema: #/definitions/tenantmodule 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/tenantmodule 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 default: description: Error response schema: #/definitions/genericError /catalog/entities/tenantmodule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantmodule responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN moduleDTO: description: Enumerado dos tipos de Módulos type: string enum: – MANAGEMENT_PANEL – PERFORMANCE_MANAGEMENT – CAREER_SUCCESSION – RECRUIT_MANAGEMENT – REMUNERATION_MANAGEMENT – DEVELOPMENT_MANAGEMENT – PAYROLL – APP – MOODS – ESOCIAL – CLOCKING_EVENT – GENERAL_REGISTER – ORGANIZATION_REGISTER – PAYROLL_DEPENDENT – ENTRY userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status tenantShortDTO: description: Versão curta de dados do tenant type: object required: – id – name – shortname properties: id: type: string description: Id name: type: string description: Nome shortname: type: string description: Nome reduzido do tenant. tenantFullDTO: description: Versão completa de dados do tenant type: object required: – id – clientCode – createdAt – cnpj – situation – platformActiveTenantSituation – hcmAuth – g5Auth – googleAuth – linkedinAuth – server – serverPort – senderEmailDefault – senderUserDefault – senderPasswordDefault – admName – admDateOfBirth – admEmail – admCountryCode – admLocalCode – admNumber – admExtention – admCpf – name – logoId – pswSendingDefaultText – authenticationEnabled – sslTrust – tlsEnabled – passwordPattern – forcePasswordChange – onPremiseVersion – lastIntegration – integratorVersion – authenticationKind – domain – shortname – cookieSession – menuKind – isMigratedMenu properties: id: type: string description: Id clientCode: type: string description: Código do cliente createdAt: type: string format: date-time description: Instante de criação cnpj: type: string description: CNPJ do cliente. situation: type: integer format: int64 description: Definição da situação atual do tenant. br \n * Campo mapeado para a enumeração {@link TenantSituation} platformActiveTenantSituation: type: boolean description: Retorno do stub do tenant hcmAuth: type: boolean description: Representa se a autenticação do HCM está habilitada g5Auth: type: boolean description: Representa se a autenticação da G5 está habilitada. googleAuth: type: boolean description: Representa se a autenticação com o Google+ está habilitada. linkedinAuth: type: boolean description: Representa se a autenticação com o Linkedin está habilitada. server: type: string description: Nome do servidor de e-mail. serverPort: type: string description: Porta do servidor de e-mail. senderEmailDefault: type: string description: Emissário padrão dos e-mails do HCM. senderUserDefault: type: string description: Usuário do emissário padrão dos e-mails do HCM. senderPasswordDefault: type: string description: Senha do emissário padrão dos e-mails do HCM. admName: type: string description: Nome do administrador do tenant admDateOfBirth: type: string format: date description: Data de nascimento do administrador do tenant. admEmail: type: string description: Endereço de e-mail do administrador do tenant. admCountryCode: type: string description: Código do país do número de telefone do administrador do tenant. admLocalCode: type: string description: Código local (DDD) do número de telefone do administrador do tenant. admNumber: type: string description: Número de telefone do administrador do tenant. admExtention: type: string description: O telefone de extensão do administrador do tenant. admCpf: type: string description: CPF do administrador do tenant. name: type: string description: Nome logoId: type: string description: ID do logotipo. pswSendingDefaultText: type: string description: Texto padrão de envio de senha ao usuário. authenticationEnabled: type: boolean description: Representa se a autenticação está ativa no servidor de configuração do emissário padrão dos e-mails. sslTrust: type: string description: Representa se o SSL trust está ativo no servidor de e-mail. tlsEnabled: type: boolean description: Representa se as configurações TLS estão ativas no servidor de e-mail. passwordPattern: type: integer format: int64 description: * Padrão para a geração de senhas dos usuários.\n * p \n * Campo mapeado para a enumeração {@link PasswordPattern} forcePasswordChange: type: boolean description: Forçar alteracao de senha ao gerar uma senha para o colaborador onPremiseVersion: type: string description: Versão OnPremise do cliente lastIntegration: type: string format: date-time description: Data e hora da última integração integratorVersion: type: string description: Versão do integrador do cliente authenticationKind: type: integer format: int64 description: * Tipo de autenticação deste tenant. br \n * Campo mapeado para a enumeração {@link AuthenticationKind} domain: type: string description: Domínio deste tenant. Usado para descobrir o tenant na autenticação dos usuários. shortname: type: string description: Nome reduzido do tenant. cookieSession: type: string description: Indica se o tenant usará cookie por sessão. menuKind: type: integer format: int64 description: Tipo de menu deste tenant. br \n * Campo mapeado para a enumeração {@link MenuKind} isMigratedMenu: type: boolean description: Representa se menu padrão do HCM está sendo utilizado. tenantmoduleFullDTO: description: Versão completa da lista de módulos do tenant type: object required: – id – tenantid – moduleDTO – hiredEmployeeAmount properties: id: type: string description: Id tenantid: type: object allOf: – #/definitions/tenant description: Id do tenant moduleDTO: type: string allOf: – #/definitions/moduleDTO description: número do módulo hiredEmployeeAmount: type: integer format: int64 description: Total de empregados contratados TenantsByModulePlatformActiveCacheDTO: description: Versão completa da lista de módulos do tenant type: object required: – considerPlatformActiveSituation – moduleDTO – hashCahe properties: considerPlatformActiveSituation: type: boolean description: Considerar apenas tenants ativos na plataforma moduleDTO: type: string allOf: – #/definitions/moduleDTO description: Número do módulo hashCahe: type: string description: HashCahe tenant: description: Entidade de cadastro de tenants/inquilinos type: object required: – id – clientcode – createdat – cnpj – situation – hcmauthentication – googleauthentication – linkedinauthentication – server – serverport – senderemaildefault – senderuserdefault – senderpassworddefault – admname – admdateofbirth – admemail – admcountrycode – admlocalcode – admnumber – admextention – admcpf – name – logo – pswsendingdefaulttext – authenticationenabled – ssltrust – tlsenabled – passwordpattern – forcepasswordchange – onpremiseversion – lastintegration – integratorversion – authenticationkind – domain – shortname – cookiesession – menukind – isMigratedMenu properties: id: type: string description: Id clientcode: type: string description: Código do cliente createdat: type: string format: date-time description: Instante de criação cnpj: type: string description: CNPJ do cliente. situation: type: integer format: int64 description: Definição da situação atual do tenant. br \n * Campo mapeado para a enumeração {@link TenantSituation} hcmauthentication: type: boolean description: Representa se a autenticação do HCM está habilitada googleauthentication: type: boolean description: Representa se a autenticação com o Google+ está habilitada. linkedinauthentication: type: boolean description: Representa se a autenticação com o Linkedin está habilitada. server: type: string description: Nome do servidor de e-mail. serverport: type: string description: Porta do servidor de e-mail. senderemaildefault: type: string description: Emissário padrão dos e-mails do HCM. senderuserdefault: type: string description: Usuário do emissário padrão dos e-mails do HCM. senderpassworddefault: type: string description: Senha do emissário padrão dos e-mails do HCM. admname: type: string description: Nome do administrador do tenant admdateofbirth: type: string format: date description: Data de nascimento do administrador do tenant. admemail: type: string description: Endereço de e-mail do administrador do tenant. admcountrycode: type: string description: Código do país do número de telefone do administrador do tenant. admlocalcode: type: string description: Código local (DDD) do número de telefone do administrador do tenant. admnumber: type: string description: Número de telefone do administrador do tenant. admextention: type: string description: O telefone de extensão do administrador do tenant. admcpf: type: string description: CPF do administrador do tenant. name: type: string description: Nome logo: type: string description: ID do logotipo. pswsendingdefaulttext: type: string description: Texto padrão de envio de senha ao usuário. authenticationenabled: type: boolean description: Representa se a autenticação está ativa no servidor de configuração do emissário padrão dos e-mails. ssltrust: type: string description: Representa se o SSL trust está ativo no servidor de e-mail. tlsenabled: type: boolean description: Representa se as configurações TLS estão ativas no servidor de e-mail. passwordpattern: type: integer format: int64 description: * Padrão para a geração de senhas dos usuários.\n * p \n * Campo mapeado para a enumeração {@link PasswordPattern} forcepasswordchange: type: boolean description: Forçar alteracao de senha ao gerar uma senha para o colaborador onpremise type: string description: Versão OnPremise do cliente lastintegration: type: string format: date-time description: Data e hora da última integração integrator type: string description: Versão do integrador do cliente authenticationkind: type: integer format: int64 description: * Tipo de autenticação deste tenant. br \n * Campo mapeado para a enumeração {@link AuthenticationKind} domain: type: string description: Domínio deste tenant. Usado para descobrir o tenant na autenticação dos usuários. shortname: type: string description: Nome reduzido do tenant. cookiesession: type: string description: Indica se o tenant usará cookie por sessão. menukind: type: integer format: int64 description: Tipo de menu deste tenant. br \n * Campo mapeado para a enumeração {@link MenuKind} isMigratedMenu: type: boolean description: Representa se menu padrão do HCM está sendo utilizado. tenantmodule: description: Entidade de Lista de módulos do tenant type: object required: – id – tenantid – module – hiredemployeeamount properties: id: type: string description: Id tenantid: type: object allOf: – #/definitions/tenant description: Id do tenant module: type: integer format: int64 description: número do módulo hiredemployeeamount: type: integer format: int64 description: Total de empregados contratados notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment