• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/Gestão de Pessoas (hcm)/Portal de Talentos – Gestão de perfis empregadores (careerscorporate)
Mais pesquisados:Customização, Tutorial, Documentação

Portal de Talentos – Gestão de perfis empregadores (careerscorporate)

40 views 0 17/07/2024 Atualizado em 18/11/2025 integrador

2.0info: 2.1.0 Portal de Talentos – Gestão de perfis empregadores description: Serviço de backend que faz parte do novo Portal de Talentos responsável por gerenciar as informações corporativas das empresas x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careerscorporate 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: /careerscorporate/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 /careerscorporate/queries/isMultipleCareerPage: post: description: Saber se está liberado para acessar a pagina múltipla de carreira tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Status do retorno de habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Saber se está liberado para acessar a pagina múltipla de carreira tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Status do retorno de habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/queries/getCandidatureSettingsByProfile: post: description: Primitiva para listar as configurações de campos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profileId properties: profileId: type: string description: Identificador único do perfil responses: 200: description: Ok schema: type: object required: – information properties: information: type: object allOf: – #/definitions/settingsInformationDTO description: Configurações de campos/subgrupos/grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para listar as configurações de campos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: profileId description: Identificador único do perfil in: query required: true type: string responses: 200: description: Ok schema: type: object required: – information properties: information: type: object allOf: – #/definitions/settingsInformationDTO description: Configurações de campos/subgrupos/grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/queries/isCollectCandidatureSourceEnabled: post: description: Saber se esta habilitado a coleta de fonte de candidatura tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Status do retorno de habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Saber se esta habilitado a coleta de fonte de candidatura tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Status do retorno de habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/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 /careerscorporate/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/queries/exportProfile: 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 /careerscorporate/queries/exportProfileAbout: 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 /careerscorporate/queries/exportCandidatureSettings: 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 /careerscorporate/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 /careerscorporate/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/actions/saveCandidatureSettings: post: description: Primitiva para persistir as configurações de campos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profileId – information properties: profileId: type: string description: Identificador único do perfil information: type: object allOf: – #/definitions/settingsInformationDTO description: Configurações de campos/subgrupos/grupos responses: 200: description: Ok schema: type: object required: – candidatureSettings properties: candidatureSettings: type: object allOf: – #/definitions/candidatureSettingsDTO description: Configurações persistidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/actions/importProfile: 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 /careerscorporate/actions/importProfileAbout: 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 /careerscorporate/actions/importCandidatureSettings: 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 /careerscorporate/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /careerscorporate/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /careerscorporate/events/importProfileEvent: 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 /careerscorporate/events/exportProfileEvent: 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 /careerscorporate/events/importProfileAboutEvent: 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 /careerscorporate/events/exportProfileAboutEvent: 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 /careerscorporate/events/importCandidatureSettingsEvent: 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 /careerscorporate/events/exportCandidatureSettingsEvent: 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 /careerscorporate/entities/company: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/company/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /careerscorporate/entities/company/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/profile: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/profile responses: 200: description: The created resource schema: #/definitions/profile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/profile responses: 200: description: The created resource schema: #/definitions/profile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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/profile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/profile/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editProfile responses: 200: description: Ok schema: #/definitions/editProfile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/profile responses: 200: description: Ok schema: #/definitions/profile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/profile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /careerscorporate/entities/profile/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/profile responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/profileAbout: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/profileAbout responses: 200: description: The created resource schema: #/definitions/profileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/profileAbout responses: 200: description: The created resource schema: #/definitions/profileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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/profileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/profileAbout/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editProfileAbout responses: 200: description: Ok schema: #/definitions/editProfileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/profileAbout responses: 200: description: Ok schema: #/definitions/profileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/profileAbout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /careerscorporate/entities/profileAbout/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/profileAbout responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/candidatureSettings: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/candidatureSettings responses: 200: description: The created resource schema: #/definitions/candidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/candidatureSettings responses: 200: description: The created resource schema: #/definitions/candidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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/candidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscorporate/entities/candidatureSettings/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCandidatureSettings responses: 200: description: Ok schema: #/definitions/editCandidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidatureSettings responses: 200: description: Ok schema: #/definitions/candidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidatureSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /careerscorporate/entities/candidatureSettings/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/candidatureSettings responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim identificationType: type: string enum: – CNPJ – NIT description: Tipo de Identificação: * `CNPJ` – Tipo de identificação no Brasil * `NIT` – Tipo de identificação da Colombia profileStatus: type: string enum: – DRAFT – PUBLISHED – DISABLED description: Status do perfil da empresa: * `DRAFT` – Modo Rascunho * `PUBLISHED` – Perfil publicado * `DISABLED` – Perfil desabilitado profileAboutSize: type: string enum: – SIZE_0_1_EMPLOYEES – SIZE_2_10_EMPLOYEES – SIZE_11_50_EMPLOYEES – SIZE_51_200_EMPLOYEES – SIZE_201_500_EMPLOYEES – SIZE_501_1000_EMPLOYEES – SIZE_1001_5000_EMPLOYEES – SIZE_5001_10000_EMPLOYEES – GREATER_THAN_10000_EMPLOYEES description: Tamanho da empresa: * `SIZE_0_1_EMPLOYEES` – Até 1 empregado * `SIZE_2_10_EMPLOYEES` – De 2 a 10 empregados * `SIZE_11_50_EMPLOYEES` – De 11 a 50 empregados * `SIZE_51_200_EMPLOYEES` – De 51 a 200 empregados * `SIZE_201_500_EMPLOYEES` – De 200 a 500 empregados * `SIZE_501_1000_EMPLOYEES` – De 501 a 1000 empregados * `SIZE_1001_5000_EMPLOYEES` – De 1001 a 5000 empregados * `SIZE_5001_10000_EMPLOYEES` – De 5001 a 10000 empregados * `GREATER_THAN_10000_EMPLOYEES` – Mais que 1000 empregados profileAboutSector: type: string enum: – AGRICULTURA_PECUARIA_PRODUCAO_FLORESTAL_PESCA_E_AQUICULTURA – AGRICULTURA_PECUARIA_E_SERVICOS_RELACIONADOS – PRODUCAO_FLORESTAL – PESCA_E_AQUICULTURA – INDUSTRIAS_EXTRATIVAS – EXTRACAO_DE_CARVAO_MINERAL – EXTRACAO_DE_PETROLEO_E_GAS_NATURAL – EXTRACAO_DE_MINERAIS_METALICOS – EXTRACAO_DE_MINERAIS_NAO_METALICOS – ATIVIDADES_DE_APOIO_A_EXTRACAO_DE_MINERAIS – INDUSTRIAS_DE_TRANSFORMACAO – FABRICACAO_DE_PRODUTOS_ALIMENTICIOS – FABRICACAO_DE_BEBIDAS – FABRICACAO_DE_PRODUTOS_DO_FUMO – FABRICACAO_DE_PRODUTOS_TEXTEIS – CONFECCAO_DE_ARTIGOS_DO_VESTUARIO_E_ACESSORIOS – PREPARACAO_DE_COUROS_E_FABRICACAO_DE_ARTEFATOS_DE_COURO_ARTIGOS_PARA_VIAGEM_E_CALCADOS – FABRICACAO_DE_PRODUTOS_DE_MADEIRA – FABRICACAO_DE_CELULOSE_PAPEL_E_PRODUTOS_DE_PAPEL – IMPRESSAO_E_REPRODUCAO_DE_GRAVACOES – FABRICACAO_DE_COQUE_DE_PRODUTOS_DERIVADOS_DO_PETROLEO_E_DE_BIOCOMBUSTIVEIS – FABRICACAO_DE_PRODUTOS_QUIMICOS – FABRICACAO_DE_PRODUTOS_FARMOQUIMICOS_E_FARMACEUTICOS – FABRICACAO_DE_PRODUTOS_DE_BORRACHA_E_DE_MATERIAL_PLASTICO – FABRICACAO_DE_PRODUTOS_DE_MINERAIS_NAO_METALICOS – METALURGIA – FABRICACAO_DE_PRODUTOS_DE_METAL_EXCETO_MAQUINAS_E_EQUIPAMENTOS – FABRICACAO_DE_EQUIPAMENTOS_DE_INFORMATICA_PRODUTOS_ELETRONICOS_E_OPTICOS – FABRICACAO_DE_MAQUINAS_APARELHOS_E_MATERIAIS_ELETRICOS – FABRICACAO_DE_MAQUINAS_E_EQUIPAMENTOS – FABRICACAO_DE_VEICULOS_AUTOMOTORES_REBOQUES_E_CARROCERIAS – FABRICACAO_DE_OUTROS_EQUIPAMENTOS_DE_TRANSPORTE_EXCETO_VEICULOS_AUTOMOTORES – FABRICACAO_DE_MOVEIS – FABRICACAO_DE_PRODUTOS_DIVERSOS – MANUTENCAO_REPARACAO_E_INSTALACAO_DE_MAQUINAS_E_EQUIPAMENTOS – ELETRICIDADE_E_GAS – ELETRICIDADE_GAS_E_OUTRAS_UTILIDADES – AGUA_ESGOTO_ATIVIDADES_DE_GESTAO_DE_RESIDUOS_E_DESCONTAMINACAO – CAPTACAO_TRATAMENTO_E_DISTRIBUICAO_DE_AGUA – ESGOTO_E_ATIVIDADES_RELACIONADAS – COLETA_TRATAMENTO_E_DISPOSICAO_DE_RESIDUOS_RECUPERACAO_DE_MATERIAIS – DESCONTAMINACAO_E_OUTROS_SERVICOS_DE_GESTAO_DE_RESIDUOS – CONSTRUCAO – CONSTRUCAO_DE_EDIFICIOS – OBRAS_DE_INFRA_ESTRUTURA – SERVICOS_ESPECIALIZADOS_PARA_CONSTRUCAO – COMERCIO_REPARACAO_DE_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS – COMERCIO_E_REPARACAO_DE_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS – COMERCIO_POR_ATACADO_EXCETO_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS – COMERCIO_VAREJISTA – TRANSPORTE_ARMAZENAGEM_E_CORREIO – TRANSPORTE_TERRESTRE – TRANSPORTE_AQUAVIARIO – TRANSPORTE_AEREO – ARMAZENAMENTO_E_ATIVIDADES_AUXILIARES_DOS_TRANSPORTES – CORREIO_E_OUTRAS_ATIVIDADES_DE_ENTREGA – ALOJAMENTO_E_ALIMENTACAO – ALOJAMENTO – ALIMENTACAO – INFORMACAO_E_COMUNICACAO – EDICAO_E_EDICAO_INTEGRADA_A_IMPRESSAO – ATIVIDADES_CINEMATOGRAFICAS_PRODUCAO_DE_VIDEOS_E_DE_PROGRAMAS_DE_TELEVISAO_GRAVACAO_DE_SOM_E_EDICAO_DE_MUSICA – ATIVIDADES_DE_RADIO_E_DE_TELEVISAO – TELECOMUNICACOES – ATIVIDADES_DOS_SERVICOS_DE_TECNOLOGIA_DA_INFORMACAO – ATIVIDADES_DE_PRESTACAO_DE_SERVICOS_DE_INFORMACAO – ATIVIDADES_FINANCEIRAS_DE_SEGUROS_E_SERVICOS_RELACIONADOS – ATIVIDADES_DE_SERVICOS_FINANCEIROS – SEGUROS_RESSEGUROS_PREVIDENCIA_COMPLEMENTAR_E_PLANOS_DE_SAUDE – ATIVIDADES_AUXILIARES_DOS_SERVICOS_FINANCEIROS_SEGUROS_PREVIDENCIA_COMPLEMENTAR_E_PLANOS_DE_SAUDE – ATIVIDADES_IMOBILIARIAS – ATIVIDADES_PROFISSIONAIS_CIENTIFICAS_E_TECNICAS – ATIVIDADES_JURIDICAS_DE_CONTABILIDADE_E_DE_AUDITORIA – ATIVIDADES_DE_SEDES_DE_EMPRESAS_E_DE_CONSULTORIA_EM_GESTAO_EMPRESARIAL – SERVICOS_DE_ARQUITETURA_E_ENGENHARIA_TESTES_E_ANALISES_TECNICAS – ATIVIDADES_ADMINISTRATIVAS_E_SERVICOS_COMPLEMENTARES – ALUGUEIS_NAO_IMOBILIARIOS_E_GESTAO_DE_ATIVOS_INTANGIVEIS_NAO_FINANCEIROS – SELECAO_AGENCIAMENTO_E_LOCACAO_DE_MAO_DE_OBRA – AGENCIAS_DE_VIAGENS_OPERADORES_TURISTICOS_E_SERVICOS_DE_RESERVAS – ADMINISTRACAO_PUBLICA_DEFESA_E_SEGURIDADE_SOCIAL – EDUCACAO – SAUDE_HUMANA_E_SERVICOS_SOCIAIS – ATIVIDADES_DE_ATENCAO_A_SAUDE_HUMANA – ATIVIDADES_DE_ATENCAO_A_SAUDE_HUMANA_INTEGRADAS_COM_ASSISTENCIA_SOCIAL_PRESTADAS_EM_RESIDENCIAS_COLETIVAS_E_PARTICULARES – SERVICOS_DE_ASSISTENCIA_SOCIAL_SEM_ALOJAMENTO – ARTES_CULTURA_ESPORTE_E_RECREACAO – ATIVIDADES_ARTISTICAS_CRIATIVAS_E_DE_ESPETACULOS – ATIVIDADES_LIGADAS_AO_PATRIMONIO_CULTURAL_E_AMBIENTAL – ATIVIDADES_DE_EXPLORACAO_DE_JOGOS_DE_AZAR_E_APOSTAS – ATIVIDADES_ESPORTIVAS_E_DE_RECREACAO_E_LAZER – OUTRAS_ATIVIDADES_DE_SERVICOS – ATIVIDADES_DE_ORGANIZACOES_ASSOCIATIVAS – REPARACAO_E_MANUTENCAO_DE_EQUIPAMENTOS_DE_INFORMATICA_E_COMUNICACAO_E_DE_OBJETOS_PESSOAIS_E_DOMESTICOS – OUTRAS_ATIVIDADES_DE_SERVICOS_PESSOAIS – SERVICOS_DOMESTICOS – ORGANISMOS_INTERNACIONAIS_E_OUTRAS_INSTITUICOES_EXTRATERRITORIAIS description: Área de atuação da empresa: * `AGRICULTURA_PECUARIA_PRODUCAO_FLORESTAL_PESCA_E_AQUICULTURA` – Agricultura, pecuária, produção florestal, pesca e aquicultura * `AGRICULTURA_PECUARIA_E_SERVICOS_RELACIONADOS` – Agricultura, pecuária e serviços relacionados * `PRODUCAO_FLORESTAL` – Produção florestal * `PESCA_E_AQUICULTURA` – Pesca e aquicultura * `INDUSTRIAS_EXTRATIVAS` – Indústrias extrativas * `EXTRACAO_DE_CARVAO_MINERAL` – Extração de carvão mineral * `EXTRACAO_DE_PETROLEO_E_GAS_NATURAL` – Extração de petróleo e gás natural * `EXTRACAO_DE_MINERAIS_METALICOS` – Extração de minerais metálicos * `EXTRACAO_DE_MINERAIS_NAO_METALICOS` – Extração de minerais não metálicos * `ATIVIDADES_DE_APOIO_A_EXTRACAO_DE_MINERAIS` – Atividades de apoio à extração de minerais * `INDUSTRIAS_DE_TRANSFORMACAO` – Indústrias de transformação * `FABRICACAO_DE_PRODUTOS_ALIMENTICIOS` – Fabricação de produtos alimentícios * `FABRICACAO_DE_BEBIDAS` – Fabricação de bebidas * `FABRICACAO_DE_PRODUTOS_DO_FUMO` – Fabricação de produtos do fumo * `FABRICACAO_DE_PRODUTOS_TEXTEIS` – Fabricação de produtos têxteis * `CONFECCAO_DE_ARTIGOS_DO_VESTUARIO_E_ACESSORIOS` – Confecção de artigos do vestuário e acessórios * `PREPARACAO_DE_COUROS_E_FABRICACAO_DE_ARTEFATOS_DE_COURO_ARTIGOS_PARA_VIAGEM_E_CALCADOS` – Preparação de couros e fabricação de artefatos de couro, artigos para viagem e calçados * `FABRICACAO_DE_PRODUTOS_DE_MADEIRA` – Fabricação de produtos de madeira * `FABRICACAO_DE_CELULOSE_PAPEL_E_PRODUTOS_DE_PAPEL` – Fabricação de celulose, papel e produtos de papel * `IMPRESSAO_E_REPRODUCAO_DE_GRAVACOES` – Impressão e reprodução de gravações * `FABRICACAO_DE_COQUE_DE_PRODUTOS_DERIVADOS_DO_PETROLEO_E_DE_BIOCOMBUSTIVEIS` – Fabricação de coque, de produtos derivados do petróleo e de biocombustíveis * `FABRICACAO_DE_PRODUTOS_QUIMICOS` – Fabricação de produtos químicos * `FABRICACAO_DE_PRODUTOS_FARMOQUIMICOS_E_FARMACEUTICOS` – Fabricação de produtos farmoquímicos e farmacêuticos * `FABRICACAO_DE_PRODUTOS_DE_BORRACHA_E_DE_MATERIAL_PLASTICO` – Fabricação de produtos de borracha e de material plástico * `FABRICACAO_DE_PRODUTOS_DE_MINERAIS_NAO_METALICOS` – Fabricação de produtos de minerais não metálicos * `METALURGIA` – Metalurgia * `FABRICACAO_DE_PRODUTOS_DE_METAL_EXCETO_MAQUINAS_E_EQUIPAMENTOS` – Fabricação de produtos de metal, exceto máquinas e equipamentos * `FABRICACAO_DE_EQUIPAMENTOS_DE_INFORMATICA_PRODUTOS_ELETRONICOS_E_OPTICOS` – Fabricação de equipamentos de informática, produtos eletrônicos e ópticos * `FABRICACAO_DE_MAQUINAS_APARELHOS_E_MATERIAIS_ELETRICOS` – Fabricação de máquinas, aparelhos e materiais elétricos * `FABRICACAO_DE_MAQUINAS_E_EQUIPAMENTOS` – Fabricação de máquinas e equipamentos * `FABRICACAO_DE_VEICULOS_AUTOMOTORES_REBOQUES_E_CARROCERIAS` – Fabricação de veículos automotores, reboques e carrocerias * `FABRICACAO_DE_OUTROS_EQUIPAMENTOS_DE_TRANSPORTE_EXCETO_VEICULOS_AUTOMOTORES` – Fabricação de outros equipamentos de transporte, exceto veículos automotores * `FABRICACAO_DE_MOVEIS` – Fabricação de móveis * `FABRICACAO_DE_PRODUTOS_DIVERSOS` – Fabricação de produtos diversos * `MANUTENCAO_REPARACAO_E_INSTALACAO_DE_MAQUINAS_E_EQUIPAMENTOS` – Manutenção, reparação e instalação de máquinas e equipamentos * `ELETRICIDADE_E_GAS` – Eletricidade e gás * `ELETRICIDADE_GAS_E_OUTRAS_UTILIDADES` – Eletricidade, gás e outras utilidades * `AGUA_ESGOTO_ATIVIDADES_DE_GESTAO_DE_RESIDUOS_E_DESCONTAMINACAO` – Água, esgoto, atividades de gestão de resíduos e descontaminação * `CAPTACAO_TRATAMENTO_E_DISTRIBUICAO_DE_AGUA` – Captação, tratamento e distribuição de água * `ESGOTO_E_ATIVIDADES_RELACIONADAS` – Esgoto e atividades relacionadas * `COLETA_TRATAMENTO_E_DISPOSICAO_DE_RESIDUOS_RECUPERACAO_DE_MATERIAIS` – Coleta, tratamento e disposição de resíduos, recuperação de materiais * `DESCONTAMINACAO_E_OUTROS_SERVICOS_DE_GESTAO_DE_RESIDUOS` – Descontaminação e outros serviços de gestão de resíduos * `CONSTRUCAO` – Construção * `CONSTRUCAO_DE_EDIFICIOS` – Construção de edifícios * `OBRAS_DE_INFRA_ESTRUTURA` – Obras de infraestrutura * `SERVICOS_ESPECIALIZADOS_PARA_CONSTRUCAO` – Serviços especializados para construção * `COMERCIO_REPARACAO_DE_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS` – Comércio e reparação de veículos automotores e motocicletas * `COMERCIO_E_REPARACAO_DE_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS` – Comércio e reparação de veículos automotores e motocicletas * `COMERCIO_POR_ATACADO_EXCETO_VEICULOS_AUTOMOTORES_E_MOTOCICLETAS` – Comércio por atacado, exceto veículos automotores e motocicletas * `COMERCIO_VAREJISTA` – Comércio varejista * `TRANSPORTE_ARMAZENAGEM_E_CORREIO` – Transporte, armazenagem e correio * `TRANSPORTE_TERRESTRE` – Transporte terrestre * `TRANSPORTE_AQUAVIARIO` – Transporte aquaviário * `TRANSPORTE_AEREO` – Transporte aéreo * `ARMAZENAMENTO_E_ATIVIDADES_AUXILIARES_DOS_TRANSPORTES` – Armazenamento e atividades auxiliares dos transportes * `CORREIO_E_OUTRAS_ATIVIDADES_DE_ENTREGA` – Correio e outras atividades de entrega * `ALOJAMENTO_E_ALIMENTACAO` – Alojamento e alimentação * `ALOJAMENTO` – Alojamento * `ALIMENTACAO` – Alimentação * `INFORMACAO_E_COMUNICACAO` – Informação e comunicação * `EDICAO_E_EDICAO_INTEGRADA_A_IMPRESSAO` – Edição e edição integrada à impressão * `ATIVIDADES_CINEMATOGRAFICAS_PRODUCAO_DE_VIDEOS_E_DE_PROGRAMAS_DE_TELEVISAO_GRAVACAO_DE_SOM_E_EDICAO_DE_MUSICA` – Atividades cinematográficas, produção de vídeos e de programas de televisão, gravação de som e edição de música * `ATIVIDADES_DE_RADIO_E_DE_TELEVISAO` – Atividades de rádio e de televisão * `TELECOMUNICACOES` – Telecomunicações * `ATIVIDADES_DOS_SERVICOS_DE_TECNOLOGIA_DA_INFORMACAO` – Atividades dos serviços de tecnologia da informação * `ATIVIDADES_DE_PRESTACAO_DE_SERVICOS_DE_INFORMACAO` – Atividades de prestação de serviços de informação * `ATIVIDADES_FINANCEIRAS_DE_SEGUROS_E_SERVICOS_RELACIONADOS` – Atividades financeiras, de seguros e serviços relacionados * `ATIVIDADES_DE_SERVICOS_FINANCEIROS` – Atividades de serviços financeiros * `SEGUROS_RESSEGUROS_PREVIDENCIA_COMPLEMENTAR_E_PLANOS_DE_SAUDE` – Seguros, resseguros, previdência complementar e planos de saúde * `ATIVIDADES_AUXILIARES_DOS_SERVICOS_FINANCEIROS_SEGUROS_PREVIDENCIA_COMPLEMENTAR_E_PLANOS_DE_SAUDE` – Atividades auxiliares dos serviços financeiros, seguros, previdência complementar e planos de saúde * `ATIVIDADES_IMOBILIARIAS` – Atividades imobiliárias * `ATIVIDADES_PROFISSIONAIS_CIENTIFICAS_E_TECNICAS` – Atividades profissionais, científicas e técnicas * `ATIVIDADES_JURIDICAS_DE_CONTABILIDADE_E_DE_AUDITORIA` – Atividades jurídicas, de contabilidade e de auditoria * `ATIVIDADES_DE_SEDES_DE_EMPRESAS_E_DE_CONSULTORIA_EM_GESTAO_EMPRESARIAL` – Atividades de sedes de empresas e de consultoria em gestão empresarial * `SERVICOS_DE_ARQUITETURA_E_ENGENHARIA_TESTES_E_ANALISES_TECNICAS` – Serviços de arquitetura e engenharia; testes e análises técnicas * `ATIVIDADES_ADMINISTRATIVAS_E_SERVICOS_COMPLEMENTARES` – Atividades administrativas e serviços complementares * `ALUGUEIS_NAO_IMOBILIARIOS_E_GESTAO_DE_ATIVOS_INTANGIVEIS_NAO_FINANCEIROS` – Aluguéis não imobiliários e gestão de ativos intangíveis não financeiros * `SELECAO_AGENCIAMENTO_E_LOCACAO_DE_MAO_DE_OBRA` – Seleção, agenciamento e locação de mão de obra * `AGENCIAS_DE_VIAGENS_OPERADORES_TURISTICOS_E_SERVICOS_DE_RESERVAS` – Agências de viagens, operadores turísticos e serviços de reservas * `ADMINISTRACAO_PUBLICA_DEFESA_E_SEGURIDADE_SOCIAL` – Administração pública, defesa e seguridade social * `EDUCACAO` – Educação * `SAUDE_HUMANA_E_SERVICOS_SOCIAIS` – Saúde humana e serviços sociais * `ATIVIDADES_DE_ATENCAO_A_SAUDE_HUMANA` – Atividades de atenção à saúde humana * `ATIVIDADES_DE_ATENCAO_A_SAUDE_HUMANA_INTEGRADAS_COM_ASSISTENCIA_SOCIAL_PRESTADAS_EM_RESIDENCIAS_COLETIVAS_E_PARTICULARES` – Atividades de atenção à saúde humana integradas com assistência social prestadas em residências coletivas e particulares * `SERVICOS_DE_ASSISTENCIA_SOCIAL_SEM_ALOJAMENTO` – Serviços de assistência social sem alojamento * `ARTES_CULTURA_ESPORTE_E_RECREACAO` – Artes, cultura, esporte e recreação * `ATIVIDADES_ARTISTICAS_CRIATIVAS_E_DE_ESPETACULOS` – Atividades artísticas, criativas e de espetáculos * `ATIVIDADES_LIGADAS_AO_PATRIMONIO_CULTURAL_E_AMBIENTAL` – Atividades ligadas ao patrimônio cultural e ambiental * `ATIVIDADES_DE_EXPLORACAO_DE_JOGOS_DE_AZAR_E_APOSTAS` – Atividades de exploração de jogos de azar e apostas * `ATIVIDADES_ESPORTIVAS_E_DE_RECREACAO_E_LAZER` – Atividades esportivas e de recreação e lazer * `OUTRAS_ATIVIDADES_DE_SERVICOS` – Outras atividades de serviços * `ATIVIDADES_DE_ORGANIZACOES_ASSOCIATIVAS` – Atividades de organizações associativas * `REPARACAO_E_MANUTENCAO_DE_EQUIPAMENTOS_DE_INFORMATICA_E_COMUNICACAO_E_DE_OBJETOS_PESSOAIS_E_DOMESTICOS` – Reparação e manutenção de equipamentos de informática e comunicação e de objetos pessoais e domésticos * `OUTRAS_ATIVIDADES_DE_SERVICOS_PESSOAIS` – Outras atividades de serviços pessoais * `SERVICOS_DOMESTICOS` – Serviços domésticos * `ORGANISMOS_INTERNACIONAIS_E_OUTRAS_INSTITUICOES_EXTRATERRITORIAIS` – Organismos internacionais e outras instituições extraterritoriais 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 checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status settingsGroupDTO: description: Grupo do dado, conforme projeto Settings type: object required: – id – enabled – subgroups properties: id: type: string description: Identificador único do grupo enabled: type: boolean description: Habilitado pela empresa subgroups: type: array items: type: object allOf: – #/definitions/settingsSubgroupDTO minimum: 1 description: Lista de subgrupos settingsSubgroupDTO: description: Subgrupo do dado, conforme projeto Settings type: object required: – id – enabled – fields properties: id: type: string description: Identificador único do subgrupo enabled: type: boolean description: Habilitado pela empresa fields: type: array items: type: object allOf: – #/definitions/settingsFieldDTO minimum: 1 description: Lista de campos settingsFieldDTO: description: Campo do dado, conforme projeto Settings type: object required: – id – enabled – required properties: id: type: string description: Identificador único do campo enabled: type: boolean description: Habilitado pela empresa required: type: boolean description: Requerido pela empresa candidatureSettingsDTO: description: Dados básicos do Candidature Settings type: object required: – id – profileId – information properties: id: type: string description: Identificador único do registro profileId: type: string description: Identificador único do perfil information: type: object allOf: – #/definitions/settingsInformationDTO description: Configurações de campos/grupos/subgrupos settingsInformationDTO: description: Configurações de campos/subgrupos/grupos (coluna Information) da tabela candidature_settings type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/settingsGroupDTO minimum: 1 description: Lista de grupos company: description: Entidade company type: object required: – name – identificationType – identificationNumber – city – state – country properties: id: type: string format: uuid description: Identificador Único da Empresa name: type: string description: Nome da Empresa identificationType: type: string allOf: – #/definitions/identificationType description: Tipo de identificação de acordo com o país identificationNumber: type: string description: Numero de identificação da Empresa city: type: string description: Cidade da empresa state: type: string description: Estado da empresa country: type: string description: Pais da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCompany: type: object required: – id allOf: – #/definitions/company profile: description: Entidade profile type: object required: – company – status properties: id: type: string format: uuid description: Identificador Unico do Perfil company: type: object allOf: – #/definitions/company description: Empresa status: type: string allOf: – #/definitions/profileStatus description: Status do perfil da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProfile: type: object required: – id allOf: – #/definitions/profile profileAbout: description: Entidade profileAbout type: object required: – profile – description properties: id: type: string format: uuid description: Identificador único do profile_about profile: type: object allOf: – #/definitions/profile description: Perfil sector: type: string allOf: – #/definitions/profileAboutSector description: Ramo de atividade da empresa size: type: string allOf: – #/definitions/profileAboutSize description: Tamanho da empresa description: type: string maxLength: 2600 description: Descrição website: type: string description: Endereço da página eletrônica da empresa na rede mundial de computadores coverPicture: type: string description: Imagem de capa profilePicture: type: string description: Imagem do perfil instagram: type: string description: Endereço da página da empresa no Instagram facebook: type: string description: Endereço da página da empresa no Facebook linkedin: type: string description: Endereço da página da empresa no LinkedIn x: type: string description: Endereço da página da empresa no X (outrora chamado de Twitter) institutionalVideo: type: string maxLength: 255 description: URL do vídeo institucional da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProfileAbout: type: object required: – id allOf: – #/definitions/profileAbout candidatureSettings: description: Entidade candidatureSettings type: object required: – profile – information properties: id: type: string format: uuid description: Identificador único do candidature_settings profile: type: object allOf: – #/definitions/profile description: Perfil information: type: string format: byte description: Dados dos grupos, subgrupos e campos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCandidatureSettings: type: object required: – id allOf: – #/definitions/candidatureSettings 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 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ê?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação